TasksAPI
Nadle / TasksAPI
Interface: TasksAPI
Defined in: packages/nadle/src/core/registration/api.ts:20
The main API for registering tasks in Nadle.
Provides overloaded register methods for registering tasks by name only,
with an inline function body, or from a keyed spec object.
Methods
register()
Call Signature
register(
name):void
Defined in: packages/nadle/src/core/registration/api.ts:22
Register a placeholder/aggregator task (name only).
Parameters
name
string
Returns
void
Call Signature
register(
name,fn):void
Defined in: packages/nadle/src/core/registration/api.ts:24
Register a task with an inline function body.
Parameters
name
string
fn
Returns
void
Call Signature
register<
Options>(name,spec):void
Defined in: packages/nadle/src/core/registration/api.ts:26
Register a task from a lazily-resolved keyed spec (see lazy).
Type Parameters
Options
Options
Parameters
name
string
spec
LazySpec<Options>
Returns
void
Call Signature
register<
Options>(name,spec):void
Defined in: packages/nadle/src/core/registration/api.ts:41
Register a task from a keyed spec whose body (run) is a Task.
Options is inferred from run so options is demanded when the task
body has required option fields and optional otherwise. Placed before the
config-only overload so TS prefers it whenever run is a Task object.
Type Parameters
Options
Options
Parameters
name
string
spec
TaskConfiguration<Options> & object & object extends Options ? object : object
Returns
void
Call Signature
register(
name,spec):void
Defined in: packages/nadle/src/core/registration/api.ts:48
Register a task from a config-only keyed spec, or one with an inline function body.
Parameters
name
string
spec
TaskConfiguration<unknown> & object
Returns
void