Class MongoDBCollectionNamespace

A class representing a collection's namespace. This class enforces (through Typescript) that the collection portion of the namespace is defined and should only be used in scenarios where this can be guaranteed.

Hierarchy

MongoDBNamespace
- MongoDBCollectionNamespace

Index

Constructors

Properties

Methods

toString withCollection fromString

Constructors

constructor

new MongoDBCollectionNamespace(db, collection): MongoDBCollectionNamespace
Parameters
- db: string
- collection: string
Returns MongoDBCollectionNamespace
Overrides MongoDBNamespace.constructor
- Defined in src/utils.ts:346

Properties

collection

collection: string

collection name

db

db: string

database name

Methods

toString

toString(): string
Returns string
Inherited from MongoDBNamespace.toString
- Defined in src/utils.ts:318

withCollection

withCollection(collection): MongoDBCollectionNamespace
Parameters
- collection: string
Returns MongoDBCollectionNamespace
Inherited from MongoDBNamespace.withCollection
- Defined in src/utils.ts:322

`Static` fromString

fromString(namespace?): MongoDBNamespace
Parameters
- Optional namespace: string
Returns MongoDBNamespace
Inherited from MongoDBNamespace.fromString
- Defined in src/utils.ts:326

Generated using TypeDoc