Class Application

Main entry point for the Application. Should be extended and have the abstract methods implemented.

Hierarchy

EventEmitter
- Application

Index

Constructors

constructor

Properties

defaultMaxListeners

Methods

Constructors

constructor

new Application(name: string, configPath: string, logSeverity?: LogSeverity): Application

- Defined in src/Application.ts:58
Parameters
- name: string
  
  The application name
- configPath: string
  
  The directory where bt-config.json and bt-local-config.json can be found. Defaults to current working directory.
- Optional logSeverity: LogSeverity
  
  Log severity. Defaults to INFO | WARNING | ERROR | FATAL
Returns Application

Properties

Static defaultMaxListeners

defaultMaxListeners: number

Methods

Protected _buildArgOptions

_buildArgOptions(program: Commander.CommanderStatic): void

- Defined in src/Application.ts:204
Parameters
- program: Commander.CommanderStatic
Returns void

Protected _createLogger

_createLogger(): Logger

- Defined in src/Application.ts:380
Creates the logger instance used by the application

Returns Logger

Logger

Protected _getDefaultLogLevel

_getDefaultLogLevel(): LogSeverity

- Defined in src/Application.ts:387
Sets the default log level on the Logger

Returns LogSeverity

Protected _llStrToSeverity

_llStrToSeverity(ll: string): LogSeverity

- Defined in src/Application.ts:444
Translates the severity string to its corresponding enumeration value.

Parameters
- ll: string
  
  sevierty string
Returns LogSeverity

Protected _parseLogLevelConfig

_parseLogLevelConfig(config: IConfig): LogSeverity

- Defined in src/Application.ts:396
Parses the log severity flags from the config object.

Parameters
- config: IConfig
  
  bt-config object
Returns LogSeverity

the severity mask

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Logger.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/events.d.ts:20
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

attachHandler

attachHandler(path: string, HandlerClass: IHandler): void

- Defined in src/Application.ts:222
Parameters
- path: string
  
  The URL API path. E.g. /api/myService/myCommand/
- HandlerClass: IHandler
  
  The concrete class (not the instance) of Handler to be used for this API.
Returns void

Protected Abstract attachHandlers

attachHandlers(): Promise<void>

- Defined in src/Application.ts:259
Subclasses are expected to attach the API handlers for their service. This will be invoked during application startup.

Returns Promise<void>

Promise

close

close(): Promise<void>

- Defined in src/Application.ts:242
Returns Promise<void>

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from Logger.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/events.d.ts:32
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from Logger.eventNames

Overrides EventEmitter.eventNames
- Defined in node_modules/@types/node/events.d.ts:33
Returns Array<string | symbol>

getCmdLineArgs

getCmdLineArgs(): any

- Defined in src/Application.ts:343
Returns any

command line arguments

getConfig

getConfig(): IConfig

- Defined in src/Application.ts:300
Returns IConfig

the config object.

getDB

getDB(): Database

- Defined in src/Application.ts:336
Returns Database

the database pool. This will need to be casted based on your preferred database dialect.

getLogger

getLogger(): Logger

- Defined in src/Application.ts:293
Returns Logger

the application's logger

getMaxListeners

getMaxListeners(): number

Inherited from Logger.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:29
Returns number

getName

getName(): string

- Defined in src/Application.ts:278
Returns string

the application name

getPort

getPort(): number

- Defined in src/Application.ts:178
Returns number

getProgram

getProgram(): Commander.CommanderStatic

- Defined in src/Application.ts:206
Returns Commander.CommanderStatic

getRequestSizeLimit

getRequestSizeLimit(): number

- Defined in src/Application.ts:213
The maximum size limit for incoming requests that this service needs to handle.

Returns number

getTokenManager

getTokenManager(): TokenManager

- Defined in src/Application.ts:329
Returns TokenManager

the token manager

Protected initDB

initDB(config: IConfig): Promise<Database>

- Defined in src/Application.ts:372
Subclasses are expected to override this to configure their database setup, if the service uses a database.

Parameters
- config: IConfig
  
  The bt-config object
Returns Promise<Database>

listenerCount

listenerCount(type: string | symbol): number

Inherited from Logger.listenerCount

Overrides EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:34
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from Logger.listeners

Overrides EventEmitter.listeners
- Defined in node_modules/@types/node/events.d.ts:30
Parameters
- event: string | symbol
Returns Function[]

loadConfig

loadConfig(path: string): Promise<IConfig>

- Defined in src/Application.ts:265
Parameters
- path: string
  
  The directory path that contains bt-config.json and bt-local-config.json
Returns Promise<IConfig>

off

off(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Logger.off

Overrides EventEmitter.off
- Defined in node_modules/@types/node/events.d.ts:26
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Logger.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/events.d.ts:21
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

Protected onBeforeReady

onBeforeReady(): void

- Defined in src/Application.ts:465
Returns void

Protected onConfigLoad

onConfigLoad(config: IConfig): void

- Defined in src/Application.ts:316
Invoked once the config has been loaded and ready to be used.

Parameters
- config: IConfig
  
  The config object (as defined in bt-config.json/bt-local-config.json)
Returns void

Protected onReady

onReady(): void

- Defined in src/Application.ts:470
Invoked when the application is considered ready for operation.

Returns void

once

once(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Logger.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:22
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Logger.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/events.d.ts:23
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Logger.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:24
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from Logger.rawListeners

Overrides EventEmitter.rawListeners
- Defined in node_modules/@types/node/events.d.ts:31
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from Logger.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:27
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from Logger.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/events.d.ts:25
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setLogger

setLogger(logger: Logger): void

- Defined in src/Application.ts:286
Parameters
- logger: Logger
  
  Logger class to use
Returns void

setMaxListeners

setMaxListeners(n: number): this

Inherited from Logger.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:28
Parameters
- n: number
Returns this

setTokenManager

setTokenManager(tokenManager: TokenManager): void

- Defined in src/Application.ts:322
Sets the TokenManager to be used for authentication.

Parameters
- tokenManager: TokenManager
Returns void

shouldListen

shouldListen(): boolean

- Defined in src/Application.ts:307
Returns boolean

true if the Application should bind to an IP address

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from Logger.listenerCount
- Defined in node_modules/@types/node/events.d.ts:17
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc