API Reference

---

Type Alias: Task<A, D, P>

Task<A, D, P> = object

Defined in: types/types.ts:205

Represents an executable task.

Type Parameters

Type Parameter	Default type
A	unknown
D extends Record<string, Task>	object
P extends Record<string, Task>	object

Properties

_tag

_tag: "task"

Defined in: types/types.ts:210

---

dependencies

dependencies: P

Defined in: types/types.ts:216

---

dependsOn

dependsOn: D

Defined in: types/types.ts:215

---

description

description: string

Defined in: types/types.ts:213

---

effect()

effect: (ctx) => Promise<A | TaskCancelled>

Defined in: types/types.ts:212

Parameters

Parameter	Type
ctx	TaskCtx

Returns

Promise<A | TaskCancelled>

---

id

readonly id: symbol

Defined in: types/types.ts:211

---

namedParams

namedParams: Record<string, NamedParam>

Defined in: types/types.ts:217

---

params

params: Record<string, TaskParam>

Defined in: types/types.ts:219

---

positionalParams

positionalParams: PositionalParam[]

Defined in: types/types.ts:218

---

tags

tags: IceTag[]

Defined in: types/types.ts:214