Skip to content

CommandDefinitionFragmentV1 ​

A command nested inside a definition document.

Fragments carry no schemaVersion. They inherit the version of the document they sit in. The standalone form is CommandDefinitionDocumentV1.

Signatures ​

ts
type CommandDefinitionFragmentV1 = unknown;

Members ​

Properties ​

aliases ​

ts
aliases?: readonly string[];

args ​

ts
args: readonly ArgDefinitionFragmentV1[];

commands ​

ts
commands: readonly CommandDefinitionFragmentV1[];

description ​

ts
description?: string;

examples ​

ts
examples?: readonly ExampleDefinitionFragmentV1[];

flags ​

ts
flags: Readonly<Record<string, FlagDefinitionFragmentV1>>;

hidden ​

ts
hidden?: true;

name ​

ts
name: string;

See Also ​

Released under the MIT License.