Skip to content

CommandSpec

CommandSpec<TOptions, TResult> = object

Defined in: src/core/types.ts:338

Command specification for typed API

Type Parameters

TOptions

TOptions

TResult

TResult

Properties

buildArgs()

buildArgs: (options) => string[]

Defined in: src/core/types.ts:344

Build argv from options

Parameters

options

TOptions

Returns

string[]


name

name: string

Defined in: src/core/types.ts:340

Command name (e.g., “status”, “log”)


outputContract

outputContract: OutputContract

Defined in: src/core/types.ts:346

Output contract


parse()

parse: (stdout, stderr) => TResult

Defined in: src/core/types.ts:348

Parse stdout/stderr to result

Parameters

stdout

string

stderr

string

Returns

TResult


subcommands?

optional subcommands: string[]

Defined in: src/core/types.ts:342

Subcommands (e.g., [“lfs”, “pull”])