Skip to content
fishbowl

BinHelp

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

Structured help content for a bin.

Properties

Section titled “Properties”

description?

Section titled “description?”

readonly optional description?: string

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

examples?

Section titled “examples?”

readonly optional examples?: readonly string[]

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

flags?

Section titled “flags?”

readonly optional flags?: readonly FlagDoc[]

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

seeAlso?

Section titled “seeAlso?”

readonly optional seeAlso?: readonly string[]

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

summary

Section titled “summary”

readonly summary: string

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

usage?

Section titled “usage?”

readonly optional usage?: string

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