Class PulseTask<Params>

PulseTask class represents a task with a callback function and various options.

Type Parameters

Params extends any[]
The types of the parameters that the task's callback function accepts.

Index

Constructors

Constructors

constructor

new PulseTask<Params>(options, ...params): PulseTask<Params>
Creates a new PulseTask instance.
Type Parameters
- Params extends any[]
Parameters
- options: PulseTaskOptions
  The options for the task.
- Rest ...params: Params
  The parameters to be passed to the task.
Returns PulseTask<Params>
- Defined in dev/Reactium/reactium-sdk-core/src/core/Pulse/index.ts:111

Properties

[_ID]

[_ID]: string

[_attempt]

[_attempt]: number

[_attempts]

[_attempts]: number

[_autostart]

[_autostart]: boolean

[_callback]

[_callback]: PulseCallback<Params>

[_complete]

[_complete]: boolean

[_count]

[_count]: number

[_delay]

[_delay]: number

[_error]

[_error]: null | Error

[_params]

[_params]: Params

[_repeat]

[_repeat]: number

[_status]

[_status]: STATUS

[_timer]

[_timer]: any

isDebugging

isDebugging: boolean = false

`Static` ENUMS

ENUMS: {
    DEBUG: boolean;
    DEFAULT: {
        ATTEMPTS: number;
        AUTOSTART: boolean;
        DELAY: number;
        REPEAT: number;
    };
    ERROR: {
        CALLBACK: string;
        ID: string;
    };
    STATUS: typeof STATUS;
} = ENUMS

Type declaration

DEBUG: boolean
DEFAULT: {
    ATTEMPTS: number;
    AUTOSTART: boolean;
    DELAY: number;
    REPEAT: number;
}
- ATTEMPTS: number
- AUTOSTART: boolean
- DELAY: number
- REPEAT: number
ERROR: {
CALLBACK: string;
ID: string;
}
- CALLBACK: string
- ID: string
STATUS: typeof STATUS

Accessors

ID

get ID(): string
Gets the ID of the task.

Returns string
The ID of the task.
- Defined in dev/Reactium/reactium-sdk-core/src/core/Pulse/index.ts:258

attempt

get attempt(): number
Gets the current attempt number of the task.

Returns number
The current attempt number of the task.
- Defined in dev/Reactium/reactium-sdk-core/src/core/Pulse/index.ts:175

attempts

get attempts(): number
Gets the maximum number of attempts for the task.

Returns number
The maximum number of attempts for the task.
- Defined in dev/Reactium/reactium-sdk-core/src/core/Pulse/index.ts:184
set attempts(value): void
Sets the maximum number of attempts for the task.
Parameters
- value: number
  The new maximum number of attempts for the task.
Returns void
- Defined in dev/Reactium/reactium-sdk-core/src/core/Pulse/index.ts:193

autostart

get autostart(): boolean
Gets the autostart status of the task.

Returns boolean
The autostart status of the task.
- Defined in dev/Reactium/reactium-sdk-core/src/core/Pulse/index.ts:204

complete

get complete(): boolean
Gets the completion status of the task.

Returns boolean
True if the task progress is 100%, otherwise false.
- Defined in dev/Reactium/reactium-sdk-core/src/core/Pulse/index.ts:213

count

get count(): number
Gets the count of the task.

Returns number
The count of the task.
- Defined in dev/Reactium/reactium-sdk-core/src/core/Pulse/index.ts:222

delay

get delay(): number
Gets the delay of the task.

Returns number
The delay of the task in milliseconds.
- Defined in dev/Reactium/reactium-sdk-core/src/core/Pulse/index.ts:231
set delay(value): void
Sets the delay for the task.
Parameters
- value: number
  The delay value in milliseconds.
Returns void
- Defined in dev/Reactium/reactium-sdk-core/src/core/Pulse/index.ts:240

error

get error(): null | Error
Gets the error of the task.

Returns null | Error
The error of the task.
- Defined in dev/Reactium/reactium-sdk-core/src/core/Pulse/index.ts:249

failed

get failed(): boolean
Gets the ID of the task.

Returns boolean
The ID of the task.
- Defined in dev/Reactium/reactium-sdk-core/src/core/Pulse/index.ts:295

progress

get progress(): number
Gets the progress of the task. If the task is set to repeat indefinitely, it returns 0. Otherwise, it calculates the progress as the ratio of the count to the repeat value.

Returns number
The fractional progress of the task.
- Defined in dev/Reactium/reactium-sdk-core/src/core/Pulse/index.ts:278

repeat

get repeat(): number
Gets the repeat value of the task.

Returns number
The repeat value of the task.
- Defined in dev/Reactium/reactium-sdk-core/src/core/Pulse/index.ts:321
set repeat(value): void
Sets the repeat value of the task.
Parameters
- value: number
  The new repeat value for the task.
Returns void
- Defined in dev/Reactium/reactium-sdk-core/src/core/Pulse/index.ts:330

status

get status(): STATUS
Gets the current status of the task.

Returns STATUS
The current status of the task.
- Defined in dev/Reactium/reactium-sdk-core/src/core/Pulse/index.ts:311

timer

get timer(): any
Gets the timer of the task.

Returns any
The timer of the task.
- Defined in dev/Reactium/reactium-sdk-core/src/core/Pulse/index.ts:267

Methods

debug

debug(...args): void
Logs the provided arguments to the console if debugging is enabled. Debugging is enabled by setting the debug option to true in the options object passed to the constructor.
Parameters
- Rest ...args: any[]
  The arguments to be logged.
Returns void
- Defined in dev/Reactium/reactium-sdk-core/src/core/Pulse/index.ts:90

now

now(): Promise<undefined | PulseTask<Params>>
Immediately executes the task and updates the task status to RUNNING. If the task execution results in an error or returns false, it throws a PulseTaskError. Otherwise, it calls the onSuccess method with the result of the task execution.

Returns Promise<undefined | PulseTask<Params>>
Returns the instance of the task.

Throws
Throws a PulseTaskError if the task execution results in an error or returns false.
- Defined in dev/Reactium/reactium-sdk-core/src/core/Pulse/index.ts:392

onError

onError(err): PulseTask<Params>
Handles an error that occurred during the execution of the task. Updates the task status to ERROR, decreases the count by 1, and attempts to retry the task.
Parameters
- err: Error
  The error that occurred during the execution of the task.
Returns PulseTask<Params>
Returns the instance of the task.
- Defined in dev/Reactium/reactium-sdk-core/src/core/Pulse/index.ts:376

onSuccess

onSuccess(result): PulseTask<Params>
Handles the successful execution of the task. Logs the success event, checks if the task needs to be repeated, and if so, restarts the task.
Parameters
- result: any
  The result of the successful task execution.
Returns PulseTask<Params>
Returns the instance of the task.
- Defined in dev/Reactium/reactium-sdk-core/src/core/Pulse/index.ts:341

reset

reset(): PulseTask<Params>
Resets the task. Stops the task, resets the internal state, and then starts the task again.

Returns PulseTask<Params>
Returns the instance of the task.
- Defined in dev/Reactium/reactium-sdk-core/src/core/Pulse/index.ts:426

retry

retry(): PulseTask<Params>
Attempts to retry the execution of the task. If the number of attempts is less than 0, it stops and starts the task. If the current attempt is greater than or equal to the maximum number of attempts, it stops the task. Otherwise, it stops and starts the task.

Returns PulseTask<Params>
Returns the instance of the task.
- Defined in dev/Reactium/reactium-sdk-core/src/core/Pulse/index.ts:447

start

start(): PulseTask<Params>
Starts the task. If the task is already running, it does nothing.

Returns PulseTask<Params>
- Defined in dev/Reactium/reactium-sdk-core/src/core/Pulse/index.ts:466

stop

stop(): PulseTask<Params>
Stops the execution of the task. Clears the timer and sets the task status to STOPPED.

Returns PulseTask<Params>
Returns the instance of the task.
- Defined in dev/Reactium/reactium-sdk-core/src/core/Pulse/index.ts:482

toString

toString(): string
Returns a string representation of the task. The string includes the task's status, count, and other relevant information.

Returns string
A string representation of the task.
- Defined in dev/Reactium/reactium-sdk-core/src/core/Pulse/index.ts:149

Class PulseTask<Params>

Type Parameters

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PulseTask<Params>

Properties

[_ID]

[_attempt]

[_attempts]

[_autostart]

[_callback]

[_complete]

[_count]

[_delay]

[_error]

[_params]

[_repeat]

[_status]

[_timer]

isDebugging

Static ENUMS

Type declaration

DEBUG: boolean

DEFAULT: { ATTEMPTS: number; AUTOSTART: boolean; DELAY: number; REPEAT: number; }

ATTEMPTS: number

AUTOSTART: boolean

DELAY: number

REPEAT: number

ERROR: { CALLBACK: string; ID: string; }

CALLBACK: string

ID: string

STATUS: typeof STATUS

Accessors

ID

Returns string

attempt

Returns number

attempts

Returns number

Parameters

Returns void

autostart

Returns boolean

complete

Returns boolean

count

Returns number

delay

Returns number

Parameters

Returns void

error

Returns null | Error

failed

Returns boolean

progress

Returns number

repeat

Returns number

Parameters

Returns void

status

Returns STATUS

timer

Returns any

Methods

debug

Parameters

Returns void

now

Returns Promise<undefined | PulseTask<Params>>

Throws

onError

`Static` ENUMS

DEFAULT: {
ATTEMPTS: number;
AUTOSTART: boolean;
DELAY: number;
REPEAT: number;
}

ERROR: {
CALLBACK: string;
ID: string;
}