Class Mongol

MongoDB helpers class.

Hierarchy

Mongol

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new Mongol(uri: string, dbName: string, options?: MongolOptions): Mongol

- Defined in src/mongol.ts:29
Parameters
- uri: string
- dbName: string
- Default value options: MongolOptions = {}
Returns Mongol

Accessors

database

get database(): Db

- Defined in src/mongol.ts:46
Database instance.

In upcoming minor versions, this will be deprecated. In the next major version, this will be removed.

Returns Db

promisifiedDatabase

get promisifiedDatabase(): Promise<Db>

- Defined in src/mongol.ts:52
Database instance, as a Promise.

Returns Promise<Db>

Methods

attachDatabaseHook

attachDatabaseHook<TSchema, TArgs, TResult>(collection: Collection<TSchema>, hook: DatabaseHook<TArgs, TResult>): ExtendedCollection<TSchema>

- Defined in src/mongol.ts:144
Attach a database hook to a collection.

Type parameters
- TSchema
- TArgs: any[]
- TResult
Parameters
- collection: Collection<TSchema>
  
  Collection.
- hook: DatabaseHook<TArgs, TResult>
  
  Database hook/trigger.
Returns ExtendedCollection<TSchema>

Collection with the hook attached.

collection

collection<TSchema>(collectionName: string): ExtendedCollection<TSchema>

- Defined in src/mongol.ts:68
Fetch a specific collection.

Type parameters
- TSchema
Parameters
- collectionName: string
  
  Collection name.
Returns ExtendedCollection<TSchema>

connect

connect(): Promise<void>

- Defined in src/mongol.ts:88
Connect to the database.

In upcoming minor versions, this will do nothing. In the next major version, this will be removed.

Returns Promise<void>

disconnect

disconnect(): Promise<void>

- Defined in src/mongol.ts:97
Disconnect from the database.

In upcoming minor versions, this will do nothing. In the next major version, this will be removed.

Returns Promise<void>

promisifiedCollection

promisifiedCollection<TSchema>(collectionName: string): Promise<ExtendedCollection<TSchema>>

- Defined in src/mongol.ts:77
Fetch a specific collection, as a Promise.

Type parameters
- TSchema
Parameters
- collectionName: string
  
  Collection name.
Returns Promise<ExtendedCollection<TSchema>>

setSchema

setSchema(collectionName: string, schema: object, options?: SchemaOptions): Promise<object>

- Defined in src/mongol.ts:109
Add or update JSON schema of a collection.

Parameters
- collectionName: string
  
  Collection name.
- schema: object
  
  JSON schema.
- Default value options: SchemaOptions = {}
  
  Options.
Returns Promise<object>

Actually used JSON schema.