Class Task<TSpec>

Single task within the task management system.

Type Parameters

TSpec extends TaskSpec = TaskSpec
Task specification type.

Hierarchy

TaskBase<TSpec>
- Task

Index

Constructors

constructor

new Task<TSpec extends TaskSpec = TaskSpec>(
    builder: TaskBuilder<TSpec>,
    name: string,
    _config: Omit<TaskConfig<TSpec>, "name">,
    data: TSpec["TData"],
): Task<TSpec>
Creates a new task instance.
Type Parameters
- TSpec extends TaskSpec = TaskSpec
Parameters
- builder: TaskBuilder<TSpec>
  Builder used to create the task.
- name: string
  Name of the task.
- _config: Omit<TaskConfig<TSpec>, "name">
  Configuration for the task.
- data: TSpec["TData"]
  Input data for the task.
Returns Task<TSpec>
Overrides TaskBase<TSpec>.constructor
- Defined in src/core/task/task.ts:50

Properties

`Protected`_progress

_progress: number = 0

Progress of the task (range 0 to 1).

Default

`Protected`_result

_result: Optional<TSpec["TResult"]> = ...

Task result, wrapped in an Optional object.

`Protected`_status

_status: TaskStatus = "idle"

Current status of the task.

Default

"idle"

`Readonly`builder

builder: TaskBuilder<TSpec>

Builder used to create the task.

`Readonly`data

data: TSpec["TData"]

Input data for the task.

`Readonly`id

id: string

Unique identifier for the task.

`Protected`logger

logger: Logger = ...

Logger for task-related events.

`Readonly`name

name: string

Name of the task.

Accessors

logs

get logs(): LogEntry[]
Logs recorded for the task.

Returns LogEntry[]
- Defined in src/core/task/task.ts:31

progress

get progress(): number
Progress of the task (range 0 to 1).

Returns number
Default
```
0
```
Inherited from TaskBase.progress
- Defined in src/core/task/task-base.ts:82
set progress(progress: number): void
Updates the task progress.
Parameters
- progress: number
  New progress value (0 to 1).
Returns void
Emits
progress - When progress changes.

Emits
param - When the progress parameter changes.
Inherited from TaskBase.progress
- Defined in src/core/task/task-base.ts:93

query

get query(): TaskQuery
Gets the TaskQuery instance bound to this task.

Returns TaskQuery
TaskQuery instance.

Throws
If the task is not bound to a query.
- Defined in src/core/task/task.ts:78

result

get result(): Optional<TSpec["TResult"]>
Task result, wrapped in an Optional object.

Returns Optional<TSpec["TResult"]>
Inherited from TaskBase.result
- Defined in src/core/task/task-base.ts:127
set result(result: Optional<TSpec["TResult"]>): void
Sets the task result.
Parameters
- result: Optional<TSpec["TResult"]>
  Result to set.
Returns void
Emits
param - When the result parameter changes.
Inherited from TaskBase.result
- Defined in src/core/task/task-base.ts:137

status

get status(): TaskStatus
Current status of the task.

Returns TaskStatus
Default
```
"idle"
```
Inherited from TaskBase.status
- Defined in src/core/task/task-base.ts:27
set status(status: TaskStatus): void
Updates the task status.
Parameters
- status: TaskStatus
  New status to set.
Returns void
Emits
param - Emits when the status parameter changes.
Inherited from TaskBase.status
- Defined in src/core/task/task-base.ts:37

Methods

bind

bind(query: TaskQuery): Task<TSpec>
Binds the task to a TaskQuery.
Parameters
- query: TaskQuery
  TaskQuery instance.
Returns Task<TSpec>
Instance of the task for chaining.
- Defined in src/core/task/task.ts:66

clear

clear(): this
Removes all listeners for all event types, as well as all global listeners.

Returns this
The EventEmitter instance itself, allowing for method chaining.
Example
```
emitter.clear(); // No more event listeners remain
```
Inherited from TaskBase.clear
- Defined in node_modules/@lilbunnyrabbit/event-emitter/dist/event-emitter.d.ts:133

clone

clone(): Task<TSpec>
Clones the task.

Returns Task<TSpec>
New task instance with the same configuration and data.
- Defined in src/core/task/task.ts:150

emit

emit<TType extends keyof TaskEvents>(
type: TType,
...data: TaskEvents[TType] extends void ? [] : [data: TaskEvents[TType]],
): this
Emits an event of a specific type, invoking all registered listeners for that event type with the provided data. Also calls any global event listeners with a GlobalEvent object.
Type Parameters
- TType extends keyof TaskEvents
  Event type.
Parameters
- type: TType
  The identifier for the event type to emit.
- ...data: TaskEvents[TType] extends void ? [] : [data: TaskEvents[TType]]
  The data to pass to the event listeners. The type of this data is defined by the corresponding value in TEvents.
Returns this
The EventEmitter instance itself, allowing for method chaining.
Example
```
emitter.emit("data", "Sample data");
emitter.emit("loaded");
emitter.emit("error", new Error("Oh no!"));
```
Inherited from TaskBase.emit
- Defined in node_modules/@lilbunnyrabbit/event-emitter/dist/event-emitter.d.ts:122

execute

execute(): Promise<Optional<TSpec["TResult"]>>
Executes the task.

Returns Promise<Optional<TSpec["TResult"]>>
Result wrapped in Optional.

Throws
If the task is not in "idle" state or if execution fails.
- Defined in src/core/task/task.ts:92

isStatus

isStatus(...statuses: TaskStatus[]): boolean
Checks if the task status matches any of the provided statuses.
Parameters
- ...statuses: TaskStatus[]
  List of statuses to check.
Returns boolean
true if the current status matches one of the provided statuses.
Inherited from TaskBase.isStatus
- Defined in src/core/task/task-base.ts:64

off

off<TType extends keyof TaskEvents>(
type: TType,
listener: EventListener<TaskEvents, TaskEvents[TType], Task<TSpec>>,
): this
Removes a previously registered event listener for a specified event type. Use this method to unregister listeners when they are no longer needed, preventing potential memory leaks.
Type Parameters
- TType extends keyof TaskEvents
  Event type.
Parameters
- type: TType
  The identifier for the event type from which to remove the listener.
- listener: EventListener<TaskEvents, TaskEvents[TType], Task<TSpec>>
  The callback function to unregister.
Returns this
The EventEmitter instance itself, allowing for method chaining.
Example
```
const onError = (error: Error) => console.error(error);

emitter.on("error", onError);

// ...

emitter.off("error", onError);
```
Inherited from TaskBase.off
- Defined in node_modules/@lilbunnyrabbit/event-emitter/dist/event-emitter.d.ts:71

offAll

offAll(listener: GlobalEventListener<TaskEvents, Task<TSpec>>): this
Removes a previously registered global event listener.
Parameters
- listener: GlobalEventListener<TaskEvents, Task<TSpec>>
  The global event listener to remove.
Returns this
The EventEmitter instance itself, allowing for method chaining.
Example
```
const globalListener = (event: GlobalEvent<TEvents>) => {
  console.log(`Event of type ${String(event.type)} received`, event.data);
};

emitter.onAll(globalListener);

// ...

emitter.offAll(globalListener);
```
Inherited from TaskBase.offAll
- Defined in node_modules/@lilbunnyrabbit/event-emitter/dist/event-emitter.d.ts:105

on

on<TType extends keyof TaskEvents>(
type: TType,
listener: EventListener<TaskEvents, TaskEvents[TType], Task<TSpec>>,
): this
Adds an event listener for a specified event type. This method allows you to specify which event you are interested in listening to and to provide a callback function that will be executed whenever that event is emitted.
Type Parameters
- TType extends keyof TaskEvents
  Event type.
Parameters
- type: TType
  The identifier for the event type to listen for.
- listener: EventListener<TaskEvents, TaskEvents[TType], Task<TSpec>>
  The callback function that will be called when the event is emitted.
Returns this
The EventEmitter instance itself, allowing for method chaining.
Example
```
emitter.on("data", (data: string) => {
  console.log("Data", data);
});

emitter.on("loaded", function () {
  console.log(
    "Emitter loaded",
    this // EventEmitter<MyEvents>
  );
});

emitter.on("error", (error: Error) => {
  console.error(`Error: ${error.message}`);
});
```
Inherited from TaskBase.on
- Defined in node_modules/@lilbunnyrabbit/event-emitter/dist/event-emitter.d.ts:50

onAll

onAll(listener: GlobalEventListener<TaskEvents, Task<TSpec>>): this
Adds a global event listener that is called for every emitted event.
Parameters
- listener: GlobalEventListener<TaskEvents, Task<TSpec>>
  The global event listener to add.
Returns this
The EventEmitter instance itself, allowing for method chaining.
Example
```
emitter.onAll((event: GlobalEvent<TEvents>) => {
  console.log(`Event of type ${String(event.type)} received`, event.data);
});
```
Inherited from TaskBase.onAll
- Defined in node_modules/@lilbunnyrabbit/event-emitter/dist/event-emitter.d.ts:85

parse

parse(): ParsedTask
Parses the task for UI rendering.

Returns ParsedTask
Parsed task data.
- Defined in src/core/task/task.ts:120

setProgress

setProgress(progress: number): Task<TSpec>
Sets the task progress.
Parameters
- progress: number
  Progress value to set.
Returns Task<TSpec>
Instance of the task for chaining.

Emits
progress - When progress changes.

Emits
param - When the progress parameter changes.
Inherited from TaskBase.setProgress
- Defined in src/core/task/task-base.ts:111

`Protected`setResult

setResult(result: Optional<TSpec["TResult"]>): this
Sets the task result and updates the status to success.
Parameters
- result: Optional<TSpec["TResult"]>
  Result to set.
Returns this
Instance of the task for chaining.

Emits
param - When the result parameter changes.
Inherited from TaskBase.setResult
- Defined in src/core/task/task-base.ts:149

setStatus

setStatus(status: TaskStatus): this
Sets the task status.
Parameters
- status: TaskStatus
  Status to set.
Returns this
Instance of the task for chaining.

Emits
param - Emits when the status parameter changes.
Inherited from TaskBase.setStatus
- Defined in src/core/task/task-base.ts:52

toString

toString(pretty?: boolean): string
Converts the task to a string representation.
Parameters
- Optionalpretty: boolean
  If true, formats the string for readability.
Returns string
String representation of the task.
- Defined in src/core/task/task.ts:137

Class Task<TSpec>

Type Parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Task<TSpec>

Properties

Protected_progress

Default

Protected_result

Protected_status

Default

Readonlybuilder

Readonlydata

Readonlyid

Protectedlogger

Readonlyname

Accessors

logs

Returns LogEntry[]

progress

Returns number

Default

Parameters

Returns void

Emits

Emits

query

Returns TaskQuery

Throws

result

Returns Optional<TSpec["TResult"]>

Parameters

Returns void

Emits

status

Returns TaskStatus

Default

Parameters

Returns void

Emits

Methods

bind

Parameters

Returns Task<TSpec>

clear

Returns this

Example

clone

Returns Task<TSpec>

emit

Type Parameters

Parameters

Returns this

Example

execute

Returns Promise<Optional<TSpec["TResult"]>>

Throws

isStatus

Parameters

Returns boolean

off

Type Parameters

Parameters

Returns this

Example

offAll

Parameters

Returns this

Example

on

Type Parameters

Parameters

`Protected`_progress

`Protected`_result

`Protected`_status

`Readonly`builder

`Readonly`data

`Readonly`id

`Protected`logger

`Readonly`name

`Protected`setResult