TasksAPI
Nadle / TasksAPI
Interface: TasksAPI
Defined in: packages/nadle/src/core/registration/api.ts:14
The main API for registering tasks in Nadle.
Provides overloaded register methods for defining tasks with or without options and custom resolvers.
Each method returns a TaskConfigurationBuilder for further configuration.
Methods
register()
Call Signature
register(
name):TaskConfigurationBuilder
Defined in: packages/nadle/src/core/registration/api.ts:20
Register a task by name only.
Parameters
name
string
The unique name of the task.
Returns
ConfigBuilder for further configuration.
Call Signature
register(
name,fnTask):TaskConfigurationBuilder
Defined in: packages/nadle/src/core/registration/api.ts:28
Register a task with a task function.
Parameters
name
string
The unique name of the task.
fnTask
The function to execute for this task.
Returns
ConfigBuilder for further configuration.
Call Signature
register<
Options>(name,optTask,optionsResolver):TaskConfigurationBuilder
Defined in: packages/nadle/src/core/registration/api.ts:37
Register a task with options and a resolver.
Type Parameters
Options
Options
Parameters
name
string
The unique name of the task.
optTask
Task<Options>
The task definition with options.
optionsResolver
Resolver<Options>
A resolver for the task's options.
Returns
ConfigBuilder for further configuration.