Class PgBossWorkerHttpServer

Hierarchy

HttpServer
- PgBossWorkerHttpServer

Index

Constructors

Properties

#config #dependencies #healthGauge app logger name server state

Methods

#getServicesHealth initialize initializeAfter initializeBefore initializeImpl shutdown shutdownAfter shutdownBefore shutdownImpl start startAfter startBefore startImpl sendJSON

Constructors

constructor

new PgBossWorkerHttpServer(cfg: PgBossWorkerArgs, deps: PgBossServiceDependencies): PgBossWorkerHttpServer
Parameters
- cfg: PgBossWorkerArgs
- deps: PgBossServiceDependencies
Returns PgBossWorkerHttpServer
Overrides HttpServer.constructor
- Defined in packages/cardano-services/src/Program/programs/pgBossWorker.ts:29

Properties

`Private` #config

#config: HttpServerConfig

`Private` #dependencies

#dependencies: HttpServerDependencies

`Private` #healthGauge

#healthGauge: Gauge<string>

app

app: Application

logger

logger: Logger

name

name: string

server

server: Server<typeof IncomingMessage, typeof ServerResponse>

state

state: RunnableModuleState

Methods

`Private` #getServicesHealth

#getServicesHealth(): Promise<{
ok: boolean;
services: ServiceHealth[];
}>
Returns Promise<{
ok: boolean;
services: ServiceHealth[];
}>
Inherited from HttpServer.#getServicesHealth
- Defined in packages/cardano-services/src/Http/HttpServer.ts:41

initialize

initialize(): Promise<void>
Returns Promise<void>
Inherited from HttpServer.initialize
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:15

initializeAfter

initializeAfter(): void
Returns void
Inherited from HttpServer.initializeAfter
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:19

initializeBefore

initializeBefore(): void
Returns void
Inherited from HttpServer.initializeBefore
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:18

`Protected` initializeImpl

initializeImpl(): Promise<void>
Returns Promise<void>
Inherited from HttpServer.initializeImpl
- Defined in packages/cardano-services/src/Http/HttpServer.ts:86

shutdown

shutdown(): Promise<void>
Returns Promise<void>
Inherited from HttpServer.shutdown
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:17

shutdownAfter

shutdownAfter(): void
Returns void
Inherited from HttpServer.shutdownAfter
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:23

shutdownBefore

shutdownBefore(): void
Returns void
Inherited from HttpServer.shutdownBefore
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:22

`Protected` shutdownImpl

shutdownImpl(): Promise<void>
Returns Promise<void>
Inherited from HttpServer.shutdownImpl
- Defined in packages/cardano-services/src/Http/HttpServer.ts:201

start

start(): Promise<void>
Returns Promise<void>
Inherited from HttpServer.start
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:16

startAfter

startAfter(): void
Returns void
Inherited from HttpServer.startAfter
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:21

startBefore

startBefore(): void
Returns void
Inherited from HttpServer.startBefore
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:20

`Protected` startImpl

startImpl(): Promise<void>
Returns Promise<void>
Inherited from HttpServer.startImpl
- Defined in packages/cardano-services/src/Http/HttpServer.ts:193

`Static` sendJSON

sendJSON<ResponseBody>(res: Response<ProviderError<unknown> | ResponseBody, Record<string, any>>, obj: ProviderError<unknown> | ResponseBody, statusCode?: number): void
Type Parameters
- ResponseBody
Parameters
- res: Response<ProviderError<unknown> | ResponseBody, Record<string, any>>
- obj: ProviderError<unknown> | ResponseBody
- statusCode: number = 200
Returns void
Inherited from HttpServer.sendJSON
- Defined in packages/cardano-services/src/Http/HttpServer.ts:183

Generated using TypeDoc