Class Service

Hierarchy

Service

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Service(serviceName: string, config?: AppConfig): Service

- Defined in lib/service.ts:16
Parameters
- serviceName: string
- Optional config: AppConfig
Returns Service

Properties

Private Readonly _config

_config: AppConfig

Private _endpoints

_endpoints: {}

Type declaration

Private Readonly _expressApp

_expressApp: Express

Private _server

_server: Server

Private Readonly _serviceName

_serviceName: string

Accessors

config

get config(): AppConfig

- Defined in lib/service.ts:176
Returns AppConfig

endpoints

get endpoints(): {}

- Defined in lib/service.ts:196
Returns {}

expressApp

get expressApp(): Express

- Defined in lib/service.ts:184
Returns Express

isRunning

get isRunning(): boolean

- Defined in lib/service.ts:188
Returns boolean

server

get server(): Server

- Defined in lib/service.ts:192
Returns Server

serviceName

get serviceName(): string

- Defined in lib/service.ts:180
Returns string

Methods

endpoint

endpoint(path: string, handler: (request: GatewayRequest, answer: GatewayAnswer) => Promise<GatewayAnswer | FileAnswer>): void

- Defined in lib/service.ts:90
Parameters
- path: string
- handler: (request: GatewayRequest, answer: GatewayAnswer) => Promise<GatewayAnswer | FileAnswer>
  - - (request: GatewayRequest, answer: GatewayAnswer): Promise<GatewayAnswer | FileAnswer>
    - Parameters
      - request: GatewayRequest
      - answer: GatewayAnswer
      Returns Promise<GatewayAnswer | FileAnswer>
Returns void

fileUploadEndpoint

fileUploadEndpoint(path: string, handler: (request: GatewayFileRequest, answer: GatewayAnswer) => Promise<GatewayAnswer | FileAnswer>): void

- Defined in lib/service.ts:58
Parameters
- path: string
- handler: (request: GatewayFileRequest, answer: GatewayAnswer) => Promise<GatewayAnswer | FileAnswer>
  - - (request: GatewayFileRequest, answer: GatewayAnswer): Promise<GatewayAnswer | FileAnswer>
    - Parameters
      - request: GatewayFileRequest
      - answer: GatewayAnswer
      Returns Promise<GatewayAnswer | FileAnswer>
Returns void

Private initDefaultRouting

initDefaultRouting(): void

- Defined in lib/service.ts:165
Returns void

Private initExpress

initExpress(): Express

- Defined in lib/service.ts:139
Returns Express

Private isAnswerValid

isAnswerValid(answer: GatewayAnswer, expectedHistory: string[]): boolean

- Defined in lib/service.ts:153
Parameters
- answer: GatewayAnswer
- expectedHistory: string[]
Returns boolean

Private sanitize

sanitize(message: GatewayRequest): GatewayRequest

- Defined in lib/service.ts:132
Parameters
- message: GatewayRequest
Returns GatewayRequest

Private sanitizePath

sanitizePath(path: string): string

- Defined in lib/service.ts:200
Parameters
- path: string
Returns string

start

start(): Promise<Service>

- Defined in lib/service.ts:25
Returns Promise<Service>

stop

stop(): Promise<Service>

- Defined in lib/service.ts:40
Returns Promise<Service>

Generated using TypeDoc