Interface StartStop<StartReturn, StopReturn>

Type Parameters

StartReturn = unknown
StopReturn = unknown

Hierarchy

Evented
- StartStop

Index

Constructors

Properties

Accessors

[eventHandled] [eventHandlers] [eventTarget] [handleEventError] [running] [statusP] [status]

Methods

addEventListener dispatchEvent removeEventListener start stop

Constructors

constructor

constructor

Properties

`Readonly` [initLock]

[initLock]: RWLockWriter

Accessors

[eventHandled]

get [eventHandled](): ReadonlyWeakSet<Event>
Returns ReadonlyWeakSet<Event>
Inherited from Evented.[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 Evented.[eventHandlers]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:6

[eventTarget]

get [eventTarget](): EventTarget
Returns EventTarget
Inherited from Evented.[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 Evented.[handleEventError]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:8

[running]

get [running](): boolean
Returns boolean
- Defined in src/StartStop.ts:29

[statusP]

get [statusP](): Promise<Status>
Returns Promise<Status>
- Defined in src/StartStop.ts:31

[status]

get [status](): Status
Returns Status
- Defined in src/StartStop.ts:30

Methods

addEventListener

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

dispatchEvent

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

removeEventListener

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

start

start(...args): Promise<void | StartReturn>
Parameters
- Rest ...args: any[]
Returns Promise<void | StartReturn>
- Defined in src/StartStop.ts:33

stop

stop(...args): Promise<void | StopReturn>
Parameters
- Rest ...args: any[]
Returns Promise<void | StopReturn>
- Defined in src/StartStop.ts:34

Generated using TypeDoc