Class ApiConsoleApp

Simple console application that hosts an express HTTP server.

A request is mapped from the HTTP request to the ApiServer event format, a ApiServer instance then processes the request. The ApiServer response is mapped to a standard HTTP response and returned to the express client.

Hierarchy

ApiApp
- ApiConsoleApp

Index

Constructors

constructor

new ApiConsoleApp(controllersPath, appConfig?, appContainer?): ApiConsoleApp
Builds an new console app.

If a value forappConfig is not passed, the serverLogger property is missing or the serverLogger.logTimestamp property is missing timestamps will be enabled for logger output.
Parameters
- controllersPath: string[]
- Optional appConfig: AppConfig
- Optional appContainer: Container
Returns ApiConsoleApp
Overrides ApiApp.constructor
- Defined in src/ApiConsoleApp.ts:41

Properties

`Protected` `Readonly` apiServer

apiServer: Server

`Protected` appConfig

appConfig: AppConfig

`Protected` appContainer

appContainer: Container

`Protected` `Optional` `Readonly` controllersPath

controllersPath?: string[]

`Protected` `Readonly` expressApp

expressApp: Application

`Protected` initialised

initialised: boolean

`Protected` `Readonly` logFactory

logFactory: LogFactory

`Protected` logger

logger: ILogger

Accessors

middlewareRegistry

get middlewareRegistry(): MiddlewareRegistry
Returns MiddlewareRegistry
Inherited from ApiApp.middlewareRegistry
- Defined in https://github.com/djfdyuruiry/ts-lambda-api/blob/master/src/ApiApp.ts

Methods

configureApi

configureApi(configureBlock): void
Configure the API instance from the lambda-api package.
Parameters
- configureBlock: ((this, api) => void)
  - - (this, api): void
    - Parameters
      
      this: void
      
      api: API
      
      Returns void
Returns void
Inherited from ApiApp.configureApi
- Defined in https://github.com/djfdyuruiry/ts-lambda-api/blob/master/src/ApiApp.ts

configureApp

configureApp(configureBlock): void
Configure the InversifyJS IOC Container instance.
Parameters
- configureBlock: ((this, container) => void)
  
  Function that takes a Container instance as a parameter.
  - - (this, container): void
    - Parameters
      
      this: void
      
      container: Container
      
      Returns void
Returns void
Inherited from ApiApp.configureApp
- Defined in https://github.com/djfdyuruiry/ts-lambda-api/blob/master/src/ApiApp.ts

initialiseControllers

initialiseControllers(): Promise<void>
Initialise all controllers and endpoints declared using decorators.

Returns Promise<void>
Inherited from ApiApp.initialiseControllers
- Defined in https://github.com/djfdyuruiry/ts-lambda-api/blob/master/src/ApiApp.ts

run

run(request, context): Promise<ApiResponse>
Parameters
- request: ApiRequest
- context: any
Returns Promise<ApiResponse>
Overrides ApiApp.run
- Defined in src/ApiConsoleApp.ts:65

runServer

runServer(args): Promise<void>
Starts the express server.
Parameters
- args: string[]
  
  Command line arguments for this server, see --help for more info.
Returns Promise<void>
- Defined in src/ApiConsoleApp.ts:75

stopServer

stopServer(): Promise<void>
Returns Promise<void>
- Defined in src/ApiConsoleApp.ts:160

Class ApiConsoleApp

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

controllersPath: string[]

Optional appConfig: AppConfig

Optional appContainer: Container

Returns ApiConsoleApp

Properties

Protected Readonly apiServer

Protected appConfig

Protected appContainer

Protected Optional Readonly controllersPath

Protected Readonly expressApp

Protected initialised

Protected Readonly logFactory

Protected logger

Accessors

middlewareRegistry

Returns MiddlewareRegistry

Methods

configureApi

Parameters

configureBlock: ((this, api) => void)

Parameters

this: void

api: API

Returns void

Returns void

configureApp

Parameters

configureBlock: ((this, container) => void)

Parameters

this: void

container: Container

Returns void

Returns void

initialiseControllers

Returns Promise<void>

run

Parameters

request: ApiRequest

context: any

Returns Promise<ApiResponse>

runServer

Parameters

args: string[]

Returns Promise<void>

stopServer

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

`Optional` appConfig: AppConfig

`Optional` appContainer: Container

`Protected` `Readonly` apiServer

`Protected` appConfig

`Protected` appContainer

`Protected` `Optional` `Readonly` controllersPath

`Protected` `Readonly` expressApp

`Protected` initialised

`Protected` `Readonly` logFactory

`Protected` logger