Skip to content

Latest commit

 

History

History
78 lines (42 loc) · 1.79 KB

Options.md

File metadata and controls

78 lines (42 loc) · 1.79 KB

Interface: Options

Options for the Health instance

Table of contents

Properties

Methods

Properties

shutdownDelaySeconds

shutdownDelaySeconds: number

The amount of time to wait before starting to shut down. There is often a delay between when Kubernetes informs the pod that it will be terminating and when all network requests to that pod have ceased, so this delay ensures that in-flight requests are not rejected. Set to a number less than or equal to 0 to disable.

default 5

Defined in

Health.ts:30


shutdownSignals

shutdownSignals: Signals[]

Signals that trigger application shutdown.

default ['SIGTERM', 'SIGHUP', 'SIGINT']

Defined in

Health.ts:37


terminationGracePeriodSeconds

terminationGracePeriodSeconds: number

The amount of time, in seconds, before the process is forcibly terminated after shutdown is initiated. Set to a value less than or equal to 0 to disable.

default 30

Defined in

Health.ts:45

Methods

forciblyTerminate

forciblyTerminate(): void

Function called to forcibly terminate the current process

default () => process.exit(1)

Returns

void

Defined in

Health.ts:21