@purista/core v2.0.5

---

PURISTA API / @purista/core / gracefulShutdown

Function: gracefulShutdown()

gracefulShutdown(logger, list, timeoutMs): void

Defined in: packages/core/src/helper/gracefulShutdown.impl.ts:37

Helps to gracefully shut down your application. Provide in list objects. The objects contains a name and a promise function which should be executed.

The execution of array list functions is done sequential.

Parameters

logger

Logger

the logger object

list

ShutdownEntry[]

a object containing name and function

timeoutMs

number = 30000

in ms to shut

Returns

void

Example

const shutDownList = [
 {
   name: `${serviceA.info.serviceName} version ${serviceA.info.serviceVersion}`,
   fn: serviceA.destroy
 },
 {
   name: `${serviceB.info.serviceName} version ${serviceB.info.serviceVersion}`,
   fn: serviceB.destroy
 },
{
   name: eventbridge.name,
   fn: eventbridge.destroy
 }
]
gracefulShutdown(logger, shutDownList)

// will shutdown ServiceA, then ServiceB, then the event bridge

Default

30000 milliseconds