API reference
burgee/meow
burgee/meow is a drop-in for meow: the same API, documented by meow itself. Every name it exports, and where its reference lives.
burgee/meow is a drop-in for meow, graded by the incumbent's own test suite. Its API is the incumbent's, so its reference is the incumbent's own documentation.
- Reference: meow 14.1.0, the release that suite is run at.
- How closely it matches: Compatibility, that suite's result in CI, with every case left out of the gate and the reason.
- Moving a program over:
burgee migraterewrites'meow'to'burgee/meow'across a project.
Exports
Every name burgee/meow exports, as the built declarations state them. Signatures and behaviour are meow's.
| Export | Kind |
|---|---|
default | const |
AnyFlag | type |
AnyFlags | type |
Flag | type |
FlagType | type |
InputOption | type |
InputOptionType | type |
IsRequiredPredicate | type |
Options | type |
Result | type |
TypedFlags | type |
burgee/commander
burgee/commander is a drop-in for commander: the same API, documented by commander itself. Every name it exports, and where its reference lives.
burgee/completions
Every export of burgee/completions, with its signature and doc comment: completionTree, renderFigSpec, renderCompletion, SHELLS, plus 1 type.