# @akiojin/command-builder

> This package implements a class that creates command line parameters.

Latest version **0.1.0** (published 2022-03-16) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @akiojin/command-builder
pnpm add @akiojin/command-builder
yarn add @akiojin/command-builder
bun add @akiojin/command-builder
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2022-03-16 |
| First published | 2022-03-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 4.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | akiojin |
| Maintainers | akiojin |
| Keywords | keychain, security |

## Links

- npm: https://www.npmjs.com/package/@akiojin/command-builder
- Repository: https://github.com/akiojin/command-builder
- Homepage: https://github.com/akiojin/command-builder#readme
- Issues: https://github.com/akiojin/command-builder/issues
- npm.io page: https://npm.io/package/@akiojin/command-builder

## Dependencies (2)

- [typescript](https://npm.io/package/typescript.md) ^4.6.2
- [@types/node](https://npm.io/package/@types/node.md) ^17.0.21

## Recent versions

- 0.1.0 (latest) — 2022-03-16

## README

# command-builder
This package implements a class that creates command line parameters.

## Usage
```js
import { CommandBuilder } from '@akiojin/command-builder'
```
```js
const builder = new CommandBuilder()
builder.AddCommand('--verbose')
builder.AddCommand('--file', 'log.txt')
builder.AddCommand([ '--output', './out' ])
await execa.execa('foo', builder.Build())
```

## Reference
### class `CommandBuilder`
#### `AddCommand(command: string | string[], param: string?): void`
##### Description
Add a command.

##### Arguments
|Name|Type|Description|
|:--|:--|:--|
|`command`|`string` \| string[]|Commands to pass to the Unity command line|
|`param`|`string?`|Parameters to be added to the command|


#### `Build(): string[]`
##### Description
Returns an array of arguments to be passed to the command line.

##### Return
|Type|Description|
|:--|:--|
|`string[]`|command array|

---
_Source: https://npm.io/package/@akiojin/command-builder · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._