ScheduledJob

Type parameters

▪ T: SuperConstructor

▪ T: SuperConstructor

▪ T: SuperConstructor

▪ T: SuperConstructor

Hierarchy

• SuperPrototypeSelector‹StatefulMixin | Struct, this› & StatefulMixin‹this› & Struct‹this›

• SuperPrototypeSelector‹Struct | StatefulMixin, this› & Struct‹this› & StatefulMixin‹this›

  ↳ ScheduledJob

Implements

• Stateful
• Definable
• Hookable
• ScheduledJob
• Definable
• Hookable
• Stateful
• ScheduledJob

Index

Constructors

• constructor

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
• getPropTypes
• getPropertyInitializers

Object literals

• STATES

Constructors

constructor

+ new ScheduledJob(props?: Props): ScheduledJob

Overrides Struct.constructor

Creates an instance of ScheduledJob. Creates an instance of ScheduledJob.

remarks Since were dealing with special cases, mixins and limits of TypeScript, we use of "invoking multiple base constructors" from polytype to pass props to Struct's constructor: https://www.npmjs.com/package/polytype#invoking-multiple-base-constructors

remarks Since were dealing with special cases, mixins and limits of TypeScript, we use of "invoking multiple base constructors" from polytype to pass props to Struct's constructor: https://www.npmjs.com/package/polytype#invoking-multiple-base-constructors

Parameters:

Name	Type	Description
props?	Props	Properties of the type required for construction.

Returns: ScheduledJob

Properties

Optional completedAt

• completedAt? : Date

Implementation of ScheduledJob.completedAt

---

data

• data: Record‹string, any›

Implementation of ScheduledJob.data

---

Optional failedAt

• failedAt? : Date

Implementation of ScheduledJob.failedAt

---

id

• id: string | Guid

Implementation of ScheduledJob.id

---

Optional lastRunAt

• lastRunAt? : Date

Implementation of ScheduledJob.lastRunAt

---

Optional lockedAt

• lockedAt? : Date

Implementation of ScheduledJob.lockedAt

---

name

• name: string

Implementation of ScheduledJob.name

---

Optional nextRunAt

• nextRunAt? : Date

Implementation of ScheduledJob.nextRunAt

---

priority

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

Implementation of ScheduledJob.priority

---

state

• state: State

Implementation of ScheduledJob.state

Overrides StatefulMixin.state

Methods

equals

▸ equals(other: any): boolean

Implementation of ScheduledJob

Inherited from DefinableMixin.equals

Overrides CreateEmployee.equals

Parameters:

Name	Type
other	any

Returns: boolean

---

getActions

▸ getActions(): Actions

Implementation of ScheduledJob

Inherited from HookableMixin.getActions

Overrides CreateEmployee.getActions

Returns: Actions

---

getHook

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

Implementation of ScheduledJob

Inherited from HookableMixin.getHook

Overrides CreateEmployee.getHook

Parameters:

Name	Type
action	string
id	string

Returns: Hook | undefined

---

getHookOrThrow

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

Implementation of ScheduledJob

Inherited from HookableMixin.getHookOrThrow

Overrides CreateEmployee.getHookOrThrow

Parameters:

Name	Type
action	string
id	string

Returns: Hook

---

getHooks

▸ getHooks(action: string): Mappings

Implementation of ScheduledJob

Inherited from HookableMixin.getHooks

Overrides CreateEmployee.getHooks

Parameters:

Name	Type
action	string

Returns: Mappings

---

getPropTypes

▸ getPropTypes(): Props

Implementation of ScheduledJob

Inherited from DefinableMixin.getPropTypes

Overrides CreateEmployee.getPropTypes

Returns: Props

---

getPropertyInitializers

▸ getPropertyInitializers(): Props

Implementation of ScheduledJob

Inherited from DefinableMixin.getPropertyInitializers

Overrides CreateEmployee.getPropertyInitializers

Returns: Props

---

getSelectableStates

▸ getSelectableStates(): Record‹string, State›

Implementation of ScheduledJob

Inherited from StatefulMixin.getSelectableStates

Overrides Task.getSelectableStates

Returns: Record‹string, State›

---

getState

▸ getState(): State

Implementation of ScheduledJob

Inherited from StatefulMixin.getState

Overrides Task.getState

Returns: State

---

hasAction

▸ hasAction(action: string): boolean

Implementation of ScheduledJob

Inherited from HookableMixin.hasAction

Overrides CreateEmployee.hasAction

Parameters:

Name	Type
action	string

Returns: boolean

---

hasHook

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

Implementation of ScheduledJob

Inherited from HookableMixin.hasHook

Overrides CreateEmployee.hasHook

Parameters:

Name	Type
action	string
id	string

Returns: boolean

---

hasState

▸ hasState(): boolean

Implementation of ScheduledJob

Inherited from StatefulMixin.hasState

Overrides Task.hasState

Returns: boolean

---

isInOneOfStates

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

Implementation of ScheduledJob

Inherited from StatefulMixin.isInOneOfStates

Overrides Task.isInOneOfStates

Parameters:

Name	Type
states	State | State[]

Returns: boolean

---

isInState

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

Implementation of ScheduledJob

Inherited from StatefulMixin.isInState

Overrides Task.isInState

Parameters:

Name	Type
state	State | State[]

Returns: boolean

---

overrideHook

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

Implementation of ScheduledJob

Inherited from HookableMixin.overrideHook

Overrides CreateEmployee.overrideHook

Parameters:

Name	Type
action	string
id	string
hook	Hook

Returns: void

---

registerHook

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

Implementation of ScheduledJob

Inherited from HookableMixin.registerHook

Overrides CreateEmployee.registerHook

Parameters:

Name	Type
action	string
id	string
hook	Hook
shouldOverride?	boolean

Returns: void

---

removeHook

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

Implementation of ScheduledJob

Inherited from HookableMixin.removeHook

Overrides CreateEmployee.removeHook

Parameters:

Name	Type
action	string
id	string

Returns: void

---

setState

▸ setState(state: State): void

Implementation of ScheduledJob

Inherited from StatefulMixin.setState

Overrides Task.setState

Parameters:

Name	Type
state	State

Returns: void

---

toPlainObject

▸ toPlainObject(): Props

Implementation of ScheduledJob

Inherited from DefinableMixin.toPlainObject

Overrides CreateEmployee.toPlainObject

Returns: Props

---

validateProps

▸ validateProps(props: Record‹string | number | symbol, any› | undefined, propTypes: PropTypes, isStrict?: boolean): boolean

Inherited from DefinableMixin.validateProps

Overrides CreateEmployee.validateProps

Parameters:

Name	Type
props	Record‹string | number | symbol, any› | undefined
propTypes	PropTypes
isStrict?	boolean

Returns: boolean

---

validateState

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

Implementation of ScheduledJob

Inherited from StatefulMixin.validateState

Overrides Task.validateState

Parameters:

Name	Type
stateOrStates	State | State[]
error?	Error

Returns: boolean

---

Static getPropTypes

▸ getPropTypes(): Props

Inherited from DefinableMixin.getPropTypes

Overrides CreateEmployee.getPropTypes

Returns: Props

---

Static getPropertyInitializers

▸ getPropertyInitializers(): Props

Inherited from DefinableMixin.getPropertyInitializers

Overrides CreateEmployee.getPropertyInitializers

Returns: Props

Object literals

Static STATES

▪ STATES: object

completed

• completed: string = "completed"

enqueued

• enqueued: string = "enqueued"

failed

• failed: string = "failed"

locked

• locked: string = "locked"

removed

• removed: string = "removed"

started

• started: string = "started"