Class CFuture<T>

The resulting object from the async_task function call with a promise of the future CResult.

Template: T

The data associated with the CResult.value function call.

Type Parameters

T
The data associated with the CResult.value function call.

Index

Constructors

Methods

cancel execute has_completed result

Constructors

constructor

new CFuture<T>(
params: { data: T; delay?: number; task: CTaskCB<T> },
): CFuture<T>
Result for the async_task function call. Must call execute() to kick-off the future task.
Type Parameters
- T
  The data associated with the CResult.value function call.
Parameters
- params: { data: T; delay?: number; task: CTaskCB<T> }
  The named parameters.
  - data: T
    
    The optional data to pass to the task.
  - Optionaldelay?: number
    
    The delay to schedule the task in the future. Defaults to 0 if not specified.
  - task: CTaskCB<T>
    
    The task to run.
Returns CFuture<T>
- Defined in codemelted.js:538

Methods

cancel

cancel(): void
Will cancel a currently running task. If no task is running then this action is a no-op.

Returns void
- Defined in codemelted.js:474

execute

execute(data?: any): void
Allows for re-execution of the CFuture wrapped task.
Parameters
- Optionaldata: any
  The optional data to pass if necessary when re-executing the task.
Returns void
- Defined in codemelted.js:490

has_completed

has_completed(): boolean
Determines if the task has completed or not.

Returns boolean
true if completed, false otherwise.
- Defined in codemelted.js:513

result

result(): Promise<CResult<T>>
Holds the result of the async_task function call.

Returns Promise<CResult<T>>
The result of the asynchronous processing.
- Defined in codemelted.js:520