PURISTA

Appearance

PURISTA API

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

Properties ​

apiMountPath? ​

optional apiMountPath: string

Defined in: types.ts:18

the api mount path

Default ​

ts
/api

disableEndpointExposing? ​

optional disableEndpointExposing: boolean

Defined in: types.ts:16

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

enableHttpCompression? ​

optional enableHttpCompression: boolean

Defined in: types.ts:20

enable HTTP compression in web server

Default ​

ts
true

healthFn() ​

healthFn: () => Promise<boolean>

Defined in: types.ts:12

health function to be executed on health check

Returns ​

Promise<boolean>

hostname? ​

optional hostname: string

Defined in: types.ts:10

hostname used in tracing and logging

logger ​

logger: Logger

Defined in: types.ts:8

a logger instance

services? ​

optional services: Service | Service[]

Defined in: types.ts:14

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