Version: Next

MainOptions

Hierarchy

ExitOptions
InitOptions
- MainOptions

Index

Properties

exit
exitCode
gracefulShutdown
gracefulShutdownDelayMillis
statusMessage
storage
timeoutSecs

Properties

optionalinheritedexit

exit?: boolean

Call process.exit()? Defaults to true

optionalinheritedexitCode

exitCode?: number

Exit code, defaults to 0

optionalinheritedgracefulShutdown

gracefulShutdown?: boolean = true

Whether to automatically handle platform shutdown signals. When enabled, Actor.exit() is called on aborting events and Actor.reboot() on migrating events.

optionalinheritedgracefulShutdownDelayMillis

gracefulShutdownDelayMillis?: number = 0

Delay in milliseconds before calling Actor.exit()/Actor.reboot() on aborting/migrating events. Since both methods already wait for all event handlers to complete, this delay is usually unnecessary.

optionalinheritedstatusMessage

statusMessage?: string

Exit with given status message

optionalinheritedstorage

storage?: StorageClient

optionalinheritedtimeoutSecs

timeoutSecs?: number = 30

Amount of time, in seconds, to wait for all event handlers to finish before exiting the process.