Class WebService

Encapsulate @godaddy/terminus.

Hierarchy

WebService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new WebService(operator: Operator, serverFactory: ServerFactory): WebService

- Defined in src/operator/web-service.ts:29
Parameters
- operator: Operator
  
  Operator owning this object.
- serverFactory: ServerFactory
  
  Factory used to build the HTTP(S) servers.
Returns WebService

Properties

cancelScopes

cancelScopes: CancelScope[]

ResourceWatcher cancel scopes.

operator

operator: Operator

Operator owning this object.

servers

servers: ServerList

List of HTTP(S) servers to manage.

Methods

beforeListen

beforeListen(): Promise<void>

- Defined in src/operator/web-service.ts:62
Hook called before listen().

Will call:
Returns Promise<void>

beforeShutdown

beforeShutdown(): Promise<void>

- Defined in src/operator/web-service.ts:77
Hook called before shutting down. Will cancel the ResourceWatcher cancel scopes.

Returns Promise<void>

listen

listen(): Promise<unknown[]>

- Defined in src/operator/web-service.ts:121
Will start the ResourceWatcher objects and the HTTP(S) servers.

Returns Promise<unknown[]>

logger

logger(msg: string, payload: any): Promise<void>

- Defined in src/operator/web-service.ts:114
Hook called by @godaddy/terminus to log messages.

Parameters
- msg: string
  
  Log message.
- payload: any
  
  Extra informations to log.
Returns Promise<void>

shutdownDone

shutdownDone(): Promise<void>

- Defined in src/operator/web-service.ts:97
Hook called once shutdown workflow is done.

Will call Operator.terminate

Returns Promise<void>

shutdownFailed

shutdownFailed(): Promise<void>

- Defined in src/operator/web-service.ts:104
Hook called if the shutdown workflow failed.

Returns Promise<void>

shutdownRequested

shutdownRequested(): Promise<void>

- Defined in src/operator/web-service.ts:88
Hook called upon reception of a SIGINT or SIGTERM signal.

Returns Promise<void>

Generated using TypeDoc