@eveble/eveble

Hierarchy

• Definable

• Hookable

• Stateful

• Definable

• Hookable

• Stateful

  ↳ ScheduledJob

Implemented by

• ScheduledJob

Index

Properties

• completedAt
• data
• failedAt
• id
• lastRunAt
• lockedAt
• name
• nextRunAt
• priority
• state

Methods

• equals
• getActions
• getHook
• getHookOrThrow
• getHooks
• getPropTypes
• getPropertyInitializers
• getSelectableStates
• getState
• hasAction
• hasHook
• hasState
• isInOneOfStates
• isInState
• overrideHook
• registerHook
• removeHook
• setState
• toPlainObject
• validateProps
• validateState

Properties

Optional completedAt

• completedAt? : Date

---

data

• data: Record‹string, any›

---

Optional failedAt

• failedAt? : Date

---

id

• id: string | Stringifiable

---

Optional lastRunAt

• lastRunAt? : Date

---

Optional lockedAt

• lockedAt? : Date

---

name

• name: string

---

Optional nextRunAt

• nextRunAt? : Date

---

priority

• priority: "lowest" | "low" | "normal" | "high" | "highest" | number

---

state

• state: State

Overrides Stateful.state

Methods

equals

▸ equals(other: any): boolean

Inherited from Definable.equals

Overrides void

Parameters:

Name	Type
other	any

Returns: boolean

---

getActions

▸ getActions(): Actions

Inherited from Hookable.getActions

Overrides void

Returns: Actions

---

getHook

▸ getHook(action: string, id: string): Hook | undefined

Inherited from Hookable.getHook

Overrides void

Parameters:

Name	Type
action	string
id	string

Returns: Hook | undefined

---

getHookOrThrow

▸ getHookOrThrow(action: string, id: string): Hook | undefined

Inherited from Hookable.getHookOrThrow

Overrides void

Parameters:

Name	Type
action	string
id	string

Returns: Hook | undefined

---

getHooks

▸ getHooks(action: string): Mappings

Inherited from Hookable.getHooks

Overrides void

Parameters:

Name	Type
action	string

Returns: Mappings

---

getPropTypes

▸ getPropTypes(): Record‹keyof any, any›

Inherited from Definable.getPropTypes

Overrides void

Returns: Record‹keyof any, any›

---

getPropertyInitializers

▸ getPropertyInitializers(): Props

Inherited from Definable.getPropertyInitializers

Overrides void

Returns: Props

---

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

---

hasAction

▸ hasAction(action: string): boolean

Inherited from Hookable.hasAction

Overrides void

Parameters:

Name	Type
action	string

Returns: boolean

---

hasHook

▸ hasHook(action: string, id: string): boolean

Inherited from Hookable.hasHook

Overrides void

Parameters:

Name	Type
action	string
id	string

Returns: boolean

---

hasState

▸ hasState(): boolean

Inherited from Stateful.hasState

Overrides void

Returns: boolean

---

isInOneOfStates

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

Inherited from Stateful.isInOneOfStates

Overrides void

Parameters:

Name	Type
states	State | State[]

Returns: boolean

---

isInState

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

Inherited from Stateful.isInState

Overrides void

Parameters:

Name	Type
state	State | State[]

Returns: boolean

---

overrideHook

▸ overrideHook(action: string, id: string, hook: Hook): void

Inherited from Hookable.overrideHook

Overrides void

Parameters:

Name	Type
action	string
id	string
hook	Hook

Returns: void

---

registerHook

▸ registerHook(action: string, id: string, hook: Hook, shouldOverride?: boolean): void

Inherited from Hookable.registerHook

Overrides void

Parameters:

Name	Type
action	string
id	string
hook	Hook
shouldOverride?	boolean

Returns: void

---

removeHook

▸ removeHook(action: string, id: string): void

Inherited from Hookable.removeHook

Overrides void

Parameters:

Name	Type
action	string
id	string

Returns: void

---

setState

▸ setState(state: State): void

Inherited from Stateful.setState

Overrides void

Parameters:

Name	Type
state	State

Returns: void

---

toPlainObject

▸ toPlainObject(): Props

Inherited from Definable.toPlainObject

Overrides void

Returns: Props

---

validateProps

▸ validateProps(props: Props, propTypes: PropTypes, isStrict?: boolean): boolean

Inherited from Definable.validateProps

Overrides void

Parameters:

Name	Type
props	Props
propTypes	PropTypes
isStrict?	boolean

Returns: boolean

---

validateState

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

Inherited from Stateful.validateState

Overrides void

Parameters:

Name	Type
stateOrStates	State | State[]
error?	Error

Returns: boolean