# burgee/yargs

> burgee/yargs is a drop-in for yargs: the same API, documented by yargs itself. Every name it exports, and where its reference lives.

Source: https://burgee.interlace.tools/docs/api/yargs

<!-- Generated by scripts/api-reference.ts from the built dist/*.d.ts and burgee/src/compat.ts. Do not edit; run `npx tsx scripts/api-reference.ts`. -->

`burgee/yargs` is a drop-in for `yargs`, graded by the incumbent's own test suite. Its API is the incumbent's, so its reference is the incumbent's own documentation.

- **Reference:** [yargs 18.2.0](https://www.npmjs.com/package/yargs/v/18.2.0), the release that suite is run at.
- **How closely it matches:** [Compatibility](/docs/compatibility), that suite's result in CI, with every case left out of the gate and the reason.
- **Side by side:** [burgee vs yargs](/docs/vs/yargs).
- **Moving a program over:** [`burgee migrate`](/docs/migrate) rewrites `'yargs'` to `'burgee/yargs'` across a project.

## Exports

Every name `burgee/yargs` exports, as the built declarations state them. Signatures and behaviour are yargs's.

| Export | Kind |
| :-- | :-- |
| `default` | const |
| `applyExtends` | function |
| `argsert` | function |
| `camelCase` | function |
| `decamelize` | function |
| `hideBin` | function |
| `isPromise` | function |
| `isYargsInstance` | function |
| `looksLikeNumber` | function |
| `objFilter` | function |
| `parseCommand` | function |
| `YargsInstance` | class |
| `YError` | class |
| `module.exports` | const |
| `platformShim` | const |
| `Argv` | interface |
| `CommandModule` | interface |
| `DetailedArguments` | interface |
| `Options` | interface |
| `ParsedCommand` | interface |
| `Parser` | interface |
| `PlatformShim` | interface |
| `PositionalOptions` | interface |
| `RequireDirectoryOptions` | interface |
| `Arguments` | type |
| `ArgumentsCamelCase` | type |
| `AsyncCompletionFunction` | type |
| `BuilderArguments` | type |
| `BuilderCallback` | type |
| `Choices` | type |
| `CommandBuilder` | type |
| `CompletionCallback` | type |
| `Defined` | type |
| `FallbackCompletionFunction` | type |
| `InferredOptionType` | type |
| `InferredOptionTypeInner` | type |
| `InferredOptionTypePrimitive` | type |
| `InferredOptionTypes` | type |
| `MiddlewareFunction` | type |
| `ParseCallback` | type |
| `ParserConfigurationOptions` | type |
| `PositionalOptionsType` | type |
| `PromiseCompletionFunction` | type |
| `SyncCompletionFunction` | type |
| `ToArray` | type |
| `ToNumber` | type |
| `ToString` | type |