FlagDoc

Defined in: packages/core/src/kernel/types.ts:1421

Flag documentation entry — one row in a bin’s OPTIONS list.

Remarks

name is the short/canonical flag key (e.g. 'a' for -a); long, when present, is the long form without leading -- (e.g. 'all'). type drives both parsing and rendering. default, when present, is the default value as a string — even for booleans it is rendered as 'true' / 'false'.

See

• BinHelp
• ParseArgsOpts

Properties

default?

readonly optional default?: string

Defined in: packages/core/src/kernel/types.ts:1425

---

description

readonly description: string

Defined in: packages/core/src/kernel/types.ts:1424

---

long?

readonly optional long?: string

Defined in: packages/core/src/kernel/types.ts:1426

---

name

readonly name: string

Defined in: packages/core/src/kernel/types.ts:1422

---

type

readonly type: "string" | "boolean"

Defined in: packages/core/src/kernel/types.ts:1423