Skip to main content

TaskBuilder

@hardkas/core

@hardkas/core / TaskBuilder

Class: TaskBuilder<Args, Hk>

Defined in: packages/core/src/tasks.ts:29

Type Parameters​

Args​

Args = any

Hk​

Hk = any

Implements​

Constructors​

Constructor​

new TaskBuilder<Args, Hk>(name, description): TaskBuilder<Args, Hk>

Defined in: packages/core/src/tasks.ts:33

Parameters​

name​

string

description​

string

Returns​

TaskBuilder<Args, Hk>

Properties​

actionFn?​

optional actionFn?: TaskAction<Args, Hk>

Defined in: packages/core/src/tasks.ts:31

Implementation of​

TaskDefinition.actionFn

description​

description: string

Defined in: packages/core/src/tasks.ts:33

Implementation of​

TaskDefinition.description

name​

name: string

Defined in: packages/core/src/tasks.ts:33

Implementation of​

TaskDefinition.name

params​

params: Record<string, TaskParam> = {}

Defined in: packages/core/src/tasks.ts:30

Implementation of​

TaskDefinition.params

Methods​

action()​

action(fn): this

Defined in: packages/core/src/tasks.ts:46

Parameters​

fn​

TaskAction<Args, Hk>

Returns​

this

Implementation of​

TaskDefinition.action

param()​

param(name, description, type?, defaultValue?): this

Defined in: packages/core/src/tasks.ts:35

Parameters​

name​

string

description​

string

type?​

"string" | "number" | "boolean"

defaultValue?​

any

Returns​

this

Implementation of​

TaskDefinition.param