Class ShutdownActionsMiddleware

Middleware which stores various actions that should be executed when app is shut down.

Hierarchy

ShutdownActionsMiddleware

Index

Constructors

Properties

logger shutdownActions shutdownActionsCalled

Methods

callShutdownActions gracefulShutdown initializeEventListeners push

Constructors

constructor

new ShutdownActionsMiddleware(logger?): ShutdownActionsMiddleware
Parameters
- logger: Logger = ...
Returns ShutdownActionsMiddleware

Properties

`Private` `Readonly` logger

logger: Logger = ...

`Private` `Readonly` shutdownActions

shutdownActions: ShutdownAction[] = []

`Private` shutdownActionsCalled

shutdownActionsCalled: boolean = false

Methods

`Private` callShutdownActions

callShutdownActions(): (void | Promise<void>)[]
Returns (void | Promise<void>)[]

`Private` gracefulShutdown

gracefulShutdown(callback): void
Parameters
- callback: (() => void)
  - - (): void
    - Returns void
Returns void

`Private` initializeEventListeners

initializeEventListeners(): void
Returns void

push

push(action): void
Adds an action to be executed right before app is shut down.
Parameters
- action: ShutdownAction
  
  sync or async function that returns void.
Returns void

Generated using TypeDoc