Class Process

Hierarchy

Process

Index

Constructors

constructor

new Process(): Process
Returns Process
- Defined in src/classes/process.ts:31

Properties

bootTime

bootTime: number

initialized

initialized: boolean

initializers

initializers: Initializers

loadInitializers

loadInitializers: (() => Promise<void>)[]

Type declaration

- (): Promise<void>
- Method run as part of the initialize lifecycle of your server. Usually sets api['YourNamespace']
  
  Returns Promise<void>

running

running: boolean

shuttingDown

shuttingDown: boolean

startCount

startCount: number

startInitializers

startInitializers: (() => Promise<void>)[]

Type declaration

- (): Promise<void>
- Method run as part of the start lifecycle of your server. Usually connects to remote servers or processes..
  
  Returns Promise<void>

started

started: boolean

stopInitializers

stopInitializers: (() => Promise<void>)[]

Type declaration

- (): Promise<void>
- Method run as part of the initialize lifecycle of your server. Usually disconnects from remote servers or processes.
  
  Returns Promise<void>

`Optional` stopReasons

stopReasons?: string[]

stopped

stopped: boolean

Methods

fatalError

fatalError(errors?, type): Promise<void>
Parameters
- errors: ErrnoException | ErrnoException[] = []
- type: string
Returns Promise<void>
- Defined in src/classes/process.ts:430

flattenOrderedInitializer

flattenOrderedInitializer<T>(collection): T[]
Type Parameters
- T
Parameters
- collection: {
  [rank: number]: T[];
  }
  - [rank: number]: T[]
Returns T[]
- Defined in src/classes/process.ts:460

initialize

initialize(): Promise<void>
Returns Promise<void>
- Defined in src/classes/process.ts:50

registerProcessSignals

registerProcessSignals(stopCallback?): void
Register listeners for process signals and uncaught exceptions & rejections. Try to gracefully shut down when signaled to do so
Parameters
- stopCallback: ((exitCode?) => void) = ...
  - - (exitCode?): void
    - Parameters
      
      Optional exitCode: number
      
      Returns void
Returns void
- Defined in src/classes/process.ts:336

restart

restart(): Promise<void>
Restart the Actionhero Process

Returns Promise<void>
- Defined in src/classes/process.ts:322

start

start(): Promise<void>
Start the Actionhero Process

Returns Promise<void>
- Defined in src/classes/process.ts:242

stop

stop(stopReasons?): Promise<void>
Stop the Actionhero Process
Parameters
- stopReasons: string | string[] = []
Returns Promise<void>
- Defined in src/classes/process.ts:275

Generated using TypeDoc