Class MongoDatabase

A MongoDB connection.

Hierarchy

MongoDatabase

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new MongoDatabase(options: MongoDatabaseOptions): MongoDatabase

- Defined in src/mongo/index.ts:106
Initializes a new instance of that class.

Parameters
- options: MongoDatabaseOptions
  
  Connection options.
Returns MongoDatabase

Properties

Private _mongo

_mongo: Connection

Readonly options

options: MongoDatabaseOptions

Connection options.

Accessors

isConnected

get isConnected(): boolean

- Defined in src/mongo/index.ts:177
Gets if there is currently an open database connection or not.

Returns boolean

mongo

get mongo(): Connection

- Defined in src/mongo/index.ts:196
Gets the underlying database connection.

Returns Connection

Methods

connect

connect(): Promise<boolean>

- Defined in src/mongo/index.ts:120
Starts a connection to the server.

Returns Promise<boolean>

The promise, which indicates if operation was successful or not.

disconnect

disconnect(): Promise<boolean>

- Defined in src/mongo/index.ts:163
Closes the current connection.

Returns Promise<boolean>

The promise, which indicates if operation was successful or not.

model

model<T>(name: string): Model<T>

- Defined in src/mongo/index.ts:188
Returns a model by name.

Type parameters
- T: Document
Parameters
- name: string
  
  The name of the model.
Returns Model<T>

The model.

query

query<T>(schema: string, func: string, ...args: any[]): DocumentQuery<T[], T>

- Defined in src/mongo/index.ts:209
Starts a query for a schema and a list of results.

Type parameters
- T: Document
Parameters
- schema: string
  
  The name of the schema.
- func: string
  
  The name of the initial function.
- Rest ...args: any[]
Returns DocumentQuery<T[], T>

The query.

queryOne

queryOne<T>(schema: string, func: string, ...args: any[]): DocumentQuery<T, T>

- Defined in src/mongo/index.ts:224
Starts a query for a schema and a single result.

Type parameters
- T: Document
Parameters
- schema: string
  
  The name of the schema.
- func: string
  
  The name of the initial function.
- Rest ...args: any[]
Returns DocumentQuery<T, T>

The query.

schema

schema(name: string): Schema

- Defined in src/mongo/index.ts:237
Returns a schema by name.

Parameters
- name: string
  
  The name of the schema.
Returns Schema

The schema.

Generated using TypeDoc