Class Queueable

Base class for an object that can be pushed to/popped from a queue.

Hierarchy

CanonicalItemClass
- Queueable

Implements

Rehydratable

Index

Constructors

constructor

Accessors

appClassApplication

Methods

Constructors

constructor

new Queueable(): Queueable

Inherited from CanonicalItemClass.constructor

Returns Queueable

Accessors

Private appClassApplication

get appClassApplication(): Application

- Defined in src/lifecycle/AppClass.ts:31
The global application instance.

Returns Application

Methods

Protected app

app(): Application

Inherited from CanonicalItemClass.app
- Defined in src/lifecycle/AppClass.ts:36
Get the global Application.

Returns Application

Protected container

container(): Container

Inherited from CanonicalItemClass.container
- Defined in src/lifecycle/AppClass.ts:41
Get the global Container.

Returns Container

defaultQueue

defaultQueue(): string

- Defined in src/support/queue/Queue.ts:32
The name of the queue where this object should be pushed by default.

Returns string

Abstract dehydrate

dehydrate(): Awaitable<JSONState>

Implementation of Rehydratable.dehydrate
- Defined in src/support/queue/Queue.ts:13
Dehydrate this class' state and get it.

Returns Awaitable<JSONState>

JSONState|Promise

Abstract execute

execute(): Awaitable<void>

- Defined in src/support/queue/Queue.ts:20
When the item is popped from the queue, this method is called.

Returns Awaitable<void>

getBoundMethod

getBoundMethod(methodName: string): (...args: any[]) => any

Inherited from CanonicalItemClass.getBoundMethod
- Defined in src/lifecycle/AppClass.ts:55
Get the method with the given name from this class, bound to this class.

Parameters
- methodName: string
Returns (...args: any[]) => any

function
- - (...args: any[]): any
  - Parameters
    - Rest ...args: any[]
    Returns any

getFullyQualifiedCanonicalResolver

getFullyQualifiedCanonicalResolver(): string

- Defined in src/support/queue/Queue.ts:40
Get the canonical resolver so we can re-instantiate this class from the queue. Throw an error if it could not be determined.

Returns string

Protected make

make<T>(target: any, ...parameters: any[]): T

Inherited from CanonicalItemClass.make
- Defined in src/lifecycle/AppClass.ts:46
Call the make() method on the global container.

Type parameters
- T
Parameters
- target: any
- Rest ...parameters: any[]
Returns T

Abstract rehydrate

rehydrate(state: JSONState): Awaitable<void>

Implementation of Rehydratable.rehydrate
- Defined in src/support/queue/Queue.ts:15
Rehydrate a state into this class.

Parameters
- state: JSONState
Returns Awaitable<void>

void|Promise

shouldQueue

shouldQueue(): boolean

- Defined in src/support/queue/Queue.ts:25
Determine whether the object should be pushed to the queue or not.

Returns boolean

Static getCanonicalResolver

getCanonicalResolver(): undefined | string

Inherited from CanonicalItemClass.getCanonicalResolver
- Defined in src/support/CanonicalReceiver.ts:58
Get the unqualified canonical resolver of this class, if one has been set.

Returns undefined | string

Static getFullyQualifiedCanonicalResolver

getFullyQualifiedCanonicalResolver(): undefined | string

Inherited from CanonicalItemClass.getFullyQualifiedCanonicalResolver
- Defined in src/support/CanonicalReceiver.ts:51
Get the fully-qualified canonical resolver of this class, if one has been set.

Returns undefined | string

Static setCanonicalResolver

setCanonicalResolver(fullyQualifiedResolver: string, unqualifiedResolver: string): void

Inherited from CanonicalItemClass.setCanonicalResolver
- Defined in src/support/CanonicalReceiver.ts:43
Sets the fully- and un-qualified canonical resolver strings. Intended for use by the Canonical unit.

Parameters
- fullyQualifiedResolver: string
- unqualifiedResolver: string
Returns void

extollo (v. latin) - to lift up, to elevate

Extollo is a free & libre application framework in TypeScript.