TaskDefinition

@hardkas/core

---

@hardkas/core / TaskDefinition

Interface: TaskDefinition<Args, Hk>

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

Type Parameters

Args

Args = any

Hk

Hk = any

Properties

actionFn?

optional actionFn?: TaskAction<Args, Hk>

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

---

description

description: string

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

---

name

name: string

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

---

params

params: Record<string, TaskParam>

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

Methods

action()

action(fn): this

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

Parameters

fn

TaskAction<Args, Hk>

Returns

this

---

param()

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

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

Parameters

name

string

description

string

type?

"string" | "number" | "boolean"

defaultValue?

any

Returns

this