Skip to main content

Interface: ChecklistBranchDef<I, B>

Defined in: src/sdk/checklist/ChecklistDefinitions.ts:67

A definition for a checklist branch.

Type Parameters​

Type ParameterDefault typeDescription
I extends BaseChecklistItemTypeDefMapBaseChecklistItemTypeDefMapA map from checklist item types to checklist item definitions used by the checklist branch. Defaults to BaseChecklistItemTypeDefMap.
BunknownThe metadata attached to the branch.

Properties​

items​

readonly items: readonly (I[Actionable] | I[Branch] | I[Note] | I[Title] | I[Link] | I[Spacer])[]

Defined in: src/sdk/checklist/ChecklistDefinitions.ts:75

Definitions for the branch's items.

metadata​

readonly metadata: B

Defined in: src/sdk/checklist/ChecklistDefinitions.ts:78

Metadata for the branch.

name​

readonly name: string

Defined in: src/sdk/checklist/ChecklistDefinitions.ts:72

The name of the branch.

uid​

readonly uid: string

Defined in: src/sdk/checklist/ChecklistDefinitions.ts:69

The unique ID of the branch.