PURISTA

Appearance

@purista/k8s-sdk v2.0.5

PURISTA API / @purista/k8s-sdk / GetHttpServerConfig

Type Alias: GetHttpServerConfig ​

GetHttpServerConfig: object

Defined in: types.ts:6

The configuration object for creating the k8s http server

Type declaration ​

apiMountPath? ​

optional apiMountPath: string

the api mount path

Default ​

ts
/api

disableEndpointExposing? ​

optional disableEndpointExposing: boolean

disables adding of all endpoints for commands which are marked to be exposed as http endpoints

enableHttpCompression? ​

optional enableHttpCompression: boolean

enable HTTP compression in web server

Default ​

ts
true

healthFn() ​

healthFn: () => Promise<boolean>

health function to be executed on health check

Returns ​

Promise<boolean>

hostname? ​

optional hostname: string

hostname used in tracing and logging

logger ​

logger: Logger

a logger instance

services? ​

optional services: Service | Service[]

service or array of services which should expose their commands as endpoints if defined