Class Status

Hierarchy

StartStop
- Status

Index

Constructors

constructor

new Status(__namedParameters): Status
Parameters
- __namedParameters: {
      fs: FileSystem;
      logger?: Logger;
      statusLockPath: string;
      statusPath: string;
  }
  - fs: FileSystem
  - Optional logger?: Logger
  - statusLockPath: string
  - statusPath: string
Returns Status
Inherited from startStop.StartStop.constructor
- Defined in src/status/Status.ts:37

Properties

`Readonly` [initLock]

[initLock]: RWLockWriter

`Protected` fs

`Protected` logger

logger: Logger

`Protected` statusLockFile

statusLockFile: FileHandle

`Readonly` statusLockPath

statusLockPath: string

`Readonly` statusPath

statusPath: string

`Protected` statusReplacer

statusReplacer: ((key, value) => any) = ...

Type declaration

- (key, value): any
- Replacer used during encoding to JSON This is a function expression and not an arrow function expression because it needs to access the this inside the JSON.stringify in order to encode the NodeId before the toJSON of IdInternal is called
  Parameters
  - key: string
  - value: any
  Returns any

`Protected` statusReviver

statusReviver: ((key, value) => any) = ...

Type declaration

- (key, value): any
- Reviver used during decoding from JSON
  Parameters
  - key: string
  - value: any
  Returns any

Accessors

[eventHandled]

get [eventHandled](): ReadonlyWeakSet<Event>
Returns ReadonlyWeakSet<Event>
Inherited from startStop.StartStop.[eventHandled]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:7

[eventHandlers]

get [eventHandlers](): ReadonlyMap<string, Set<EventHandlerInfo>>
Returns ReadonlyMap<string, Set<EventHandlerInfo>>
Inherited from startStop.StartStop.[eventHandlers]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:6

[eventTarget]

get [eventTarget](): EventTarget
Returns EventTarget
Inherited from startStop.StartStop.[eventTarget]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:5

[handleEventError]

get [handleEventError](): ((evt) => void)
Returns ((evt) => void)
- - (evt): void
  - Parameters
    - evt: EventError
    Returns void
Inherited from startStop.StartStop.[handleEventError]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:8

[running]

get [running](): boolean
Returns boolean
Inherited from startStop.StartStop.[running]
- Defined in node_modules/@matrixai/async-init/dist/StartStop.d.ts:6

[statusP]

get [statusP](): Promise<Status>
Returns Promise<Status>
Inherited from startStop.StartStop.[statusP]
- Defined in node_modules/@matrixai/async-init/dist/StartStop.d.ts:8

[status]

get [status](): Status
Returns Status
Inherited from startStop.StartStop.[status]
- Defined in node_modules/@matrixai/async-init/dist/StartStop.d.ts:7

Methods

addEventListener

addEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Inherited from startStop.StartStop.addEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:9

beginStop

beginStop(data): Promise<void>
Parameters
- data: {
  pid: number;
  [key: string]: any;
  }
  - [key: string]: any
  - pid: number
Returns Promise<void>
- Defined in src/status/Status.ts:88

dispatchEvent

dispatchEvent(event): boolean
Parameters
- event: Event
Returns boolean
Inherited from startStop.StartStop.dispatchEvent
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:11

finishStart

finishStart(data): Promise<void>
Parameters
- data: {
      agentHost: string;
      agentPort: number;
      clientHost: string;
      clientPort: number;
      nodeId: NodeId;
      pid: number;
      [key: string]: any;
  }
  - [key: string]: any
  - agentHost: string
  - agentPort: number
  - clientHost: string
  - clientPort: number
  - nodeId: NodeId
  - pid: number
Returns Promise<void>
- Defined in src/status/Status.ts:78

readStatus

readStatus(): Promise<undefined | StatusInfo>
Read the status data This can be used without running Status

Returns Promise<undefined | StatusInfo>
- Defined in src/status/Status.ts:114

removeEventListener

removeEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void
Inherited from startStop.StartStop.removeEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:10

start

start(data): Promise<void>
Parameters
- data: {
  pid: number;
  [key: string]: any;
  }
  - [key: string]: any
  - pid: number
Returns Promise<void>
Inherited from startStop.StartStop.start
- Defined in src/status/Status.ts:54

stop

stop(data): Promise<void>
Parameters
- data: {
  [key: string]: any;
  }
  - [key: string]: any
Returns Promise<void>
Inherited from startStop.StartStop.stop
- Defined in src/status/Status.ts:98

updateStatusLive

updateStatusLive(data): Promise<StatusInfo>
Parameters
- data: Partial<{
      agentHost: string;
      agentPort: number;
      clientHost: string;
      clientPort: number;
      nodeId: NodeId;
      pid: number;
      [key: string]: any;
  }>
Returns Promise<StatusInfo>
- Defined in src/status/Status.ts:219

waitFor

waitFor(status, ctx?): PromiseCancellable<StatusInfo>
Parameters
- status: "STARTING" | "LIVE" | "STOPPING" | "DEAD"
- Optional ctx: Partial<ContextTimedInput>
Returns PromiseCancellable<StatusInfo>
- Defined in src/status/Status.ts:305

`Protected` writeStatus

writeStatus(statusInfo): Promise<void>
Parameters
- statusInfo: StatusInfo
Returns Promise<void>
- Defined in src/status/Status.ts:178

Generated using TypeDoc