@eveble/eveble

Hierarchy

Implemented by

Index

Properties

Methods

Properties

state

state: State

Inherited from Stateful.state

Overrides void

Methods

getInterval

getInterval(): number

Returns: number

getInterval(): number

Returns: number


getJob

getJob(commandType: string, assignerId: string | Stringifiable, assignerType: string, assignmentId?: string | Stringifiable): Promise‹ScheduledJob | undefined›

Parameters:

NameType
commandTypestring
assignerIdstring | Stringifiable
assignerTypestring
assignmentId?string | Stringifiable

Returns: Promise‹ScheduledJob | undefined›

getJob(commandType: string, assignerId: string | Stringifiable, assignerType: string, assignmentId?: string | Stringifiable): Promise‹ScheduledJob | undefined›

Parameters:

NameType
commandTypestring
assignerIdstring | Stringifiable
assignerTypestring
assignmentId?string | Stringifiable

Returns: Promise‹ScheduledJob | undefined›


getSelectableStates

getSelectableStates(): Record‹string, State

Inherited from Stateful.getSelectableStates

Overrides void

Returns: Record‹string, State


getState

getState(): State

Inherited from Stateful.getState

Overrides void

Returns: State


hasState

hasState(): boolean

Inherited from Stateful.hasState

Overrides void

Returns: boolean


initialize

initialize(): Promise‹void›

Returns: Promise‹void›

initialize(): Promise‹void›

Returns: Promise‹void›


isInOneOfStates

isInOneOfStates(states: State | State[]): boolean

Inherited from Stateful.isInOneOfStates

Overrides void

Parameters:

NameType
statesState | State[]

Returns: boolean


isInState

isInState(state: State | State[]): boolean

Inherited from Stateful.isInState

Overrides void

Parameters:

NameType
stateState | State[]

Returns: boolean


schedule

schedule(scheduleCommand: ScheduleCommand): Promise‹void›

Parameters:

NameType
scheduleCommandScheduleCommand

Returns: Promise‹void›

schedule(scheduleCommand: ScheduleCommand): Promise‹void›

Parameters:

NameType
scheduleCommandScheduleCommand

Returns: Promise‹void›


setState

setState(state: State): void

Inherited from Stateful.setState

Overrides void

Parameters:

NameType
stateState

Returns: void


startScheduling

startScheduling(): Promise‹void›

Returns: Promise‹void›

startScheduling(): Promise‹void›

Returns: Promise‹void›


stopScheduling

stopScheduling(): Promise‹void›

Returns: Promise‹void›

stopScheduling(): Promise‹void›

Returns: Promise‹void›


unschedule

unschedule(unscheduleCommand: UnscheduleCommand): Promise‹boolean›

Parameters:

NameType
unscheduleCommandUnscheduleCommand

Returns: Promise‹boolean›

unschedule(unscheduleCommand: UnscheduleCommand): Promise‹boolean›

Parameters:

NameType
unscheduleCommandUnscheduleCommand

Returns: Promise‹boolean›


unscheduleAll

unscheduleAll(): Promise‹void›

Returns: Promise‹void›

unscheduleAll(): Promise‹void›

Returns: Promise‹void›


validateState

validateState(stateOrStates: State | State[], error?: Error): boolean

Inherited from Stateful.validateState

Overrides void

Parameters:

NameType
stateOrStatesState | State[]
error?Error

Returns: boolean