Class MongoApiHost<TDatabase, TOptions>

An API with MongoDB helper methods.

Type parameters

TDatabase: MongoDatabase
TOptions: MongoDatabaseOptions

Hierarchy

ApiHost
- MongoApiHost

Index

Accessors

Methods

Accessors

app

get app(): express.Express

Inherited from ApiHost.app
- Defined in src/apis/host.ts:102
Gets the underlying Express app instance.

Returns express.Express

isRunning

get isRunning(): boolean

Inherited from ApiHost.isRunning
- Defined in src/apis/host.ts:261
Gets if the host is currently running or not.

Returns boolean

logger

get logger(): Logger

Inherited from ApiHost.logger
- Defined in src/apis/host.ts:268
Gets the underlying logger.

Returns Logger

root

get root(): express.Router

Inherited from ApiHost.root
- Defined in src/apis/host.ts:293
Gets the root endpoint.

Returns express.Router

Methods

authorizer

authorizer(): ApiAuthorizer
authorizer(newValue: ApiAuthorizer): this

Inherited from ApiHost.authorizer
- Defined in src/apis/host.ts:113
Gets or sets if an authorizer should be used or not.

Returns ApiAuthorizer

The current value or that instance if new value has been set.
Inherited from ApiHost.authorizer
- Defined in src/apis/host.ts:114
Parameters
- newValue: ApiAuthorizer
Returns this

Protected getDatabaseClass

getDatabaseClass(): typeof MongoDatabase

- Defined in src/apis/host.ts:511
Returns the database class.

Returns typeof MongoDatabase

The class.

initialize

initialize(opts?: InitializeApiHostOptions): void

Inherited from ApiHost.initialize
- Defined in src/apis/host.ts:130
(Re-)Initializes the host.

Parameters
- Optional opts: InitializeApiHostOptions
Returns void

log

log(message: any, type: LogType, payload?: any): Promise<void>

- Defined in src/apis/host.ts:523
Log something into the database. This requires a 'logs' collection, described by 'LogsDocument' interface.

Parameters
- message: any
  
  The message.
- type: LogType
  
  The type.
- Optional payload: any
Returns Promise<void>

openDatabase

openDatabase(opts?: TOptions): Promise<TDatabase>

- Defined in src/apis/host.ts:548
Options a new connection to a database.

Parameters
- Optional opts: TOptions
Returns Promise<TDatabase>

The new, opened, database.

poweredBy

poweredBy(): string
poweredBy(newValue: string): this

Inherited from ApiHost.poweredBy
- Defined in src/apis/host.ts:279
Gets or sets the 'X-Powered-By' header.

Returns string

The current value or that instance if new value has been set.
Inherited from ApiHost.poweredBy
- Defined in src/apis/host.ts:280
Parameters
- newValue: string
Returns this

setBasicAuth

setBasicAuth(authorizer: BasicAuthAuthorizer): this

Inherited from ApiHost.setBasicAuth
- Defined in src/apis/host.ts:304
Sets a 'Basic Auth' based authorizer.

Parameters
- authorizer: BasicAuthAuthorizer
  
  The authorizer.
Returns this

this

setPrefixedAuthorizer

setPrefixedAuthorizer(authorizer: TokenAuthorizer, prefix?: string): this

Inherited from ApiHost.setPrefixedAuthorizer
- Defined in src/apis/host.ts:347
Sets a prefixed based authorizer.

Parameters
- authorizer: TokenAuthorizer
  
  The authorizer.
- Default value prefix: string = "bearer"
Returns this

this

Protected setupApi

setupApi(newApp: express.Express, newRoot: express.Router): void

Inherited from ApiHost.setupApi
- Defined in src/apis/host.ts:370
Sets up a new api / app instance.

Parameters
- newApp: express.Express
  
  The instance to setup.
- newRoot: express.Router
  
  The API root.
Returns void

Protected setupLogger

setupLogger(newLogger: Logger): void

Inherited from ApiHost.setupLogger
- Defined in src/apis/host.ts:378
Sets up a new logger instance.

Parameters
- newLogger: Logger
  
  The instance to setup.
Returns void

start

start(port?: number): Promise<boolean>

Inherited from ApiHost.start
- Defined in src/apis/host.ts:389
Starts the host.

Parameters
- Optional port: number
Returns Promise<boolean>

The promise, which indicates if operation successful or not.

stop

stop(): Promise<boolean>

Inherited from ApiHost.stop
- Defined in src/apis/host.ts:439
Stops the host.

Returns Promise<boolean>

The promise, which indicates if operation successful or not.

useBodyParser

useBodyParser(): UseBodyParserSetting
useBodyParser(newValue: UseBodyParserSetting): this

Inherited from ApiHost.useBodyParser
- Defined in src/apis/host.ts:467
Gets or sets if 'body-parser' module should be used or not.

Returns UseBodyParserSetting

The current value or that instance if new value has been set.
Inherited from ApiHost.useBodyParser
- Defined in src/apis/host.ts:468
Parameters
- newValue: UseBodyParserSetting
Returns this

useErrorHandler

useErrorHandler(): UseErrorHandlerSetting
useErrorHandler(newValue: UseErrorHandlerSetting): this

Inherited from ApiHost.useErrorHandler
- Defined in src/apis/host.ts:486
Gets or sets if 'errorhandler' module should be used or not.

Returns UseErrorHandlerSetting

The current value or that instance if new value has been set.
Inherited from ApiHost.useErrorHandler
- Defined in src/apis/host.ts:487
Parameters
- newValue: UseErrorHandlerSetting
Returns this

withDatabase

withDatabase<TResult>(action: (db: TDatabase) => TResult | PromiseLike<TResult>, opts?: TOptions): Promise<TResult>

- Defined in src/apis/host.ts:581
Opens a data connection and invokes an action for it. After invokation, the database is closed automatically.

Type parameters
- TResult
Parameters
- action: (db: TDatabase) => TResult | PromiseLike<TResult>
  
  The action to invoke.
  - - (db: TDatabase): TResult | PromiseLike<TResult>
    - Parameters
      - db: TDatabase
      Returns TResult | PromiseLike<TResult>
- Optional opts: TOptions
Returns Promise<TResult>

The promise with the result of the action.

Generated using TypeDoc