# decarg > decorator based cli arguments parser Latest version **1.3.0** (published 2022-08-21) · MIT license · 0 weekly downloads ## Install ```sh npm install decarg pnpm add decarg yarn add decarg bun add decarg ``` ## Health **Score 30/100 (F)** — status: abandoned. Positive: has types; esm support; no vulnerabilities; high quality score. Warnings: low downloads. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.3.0 | | Published | 2022-08-21 | | First published | 2021-11-13 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 1 | | Unpacked size | 362.6 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 1 | | Author | stagas | | Maintainers | stagas | | Keywords | decorator, options, arguments, cli, parser | ## Links - npm: https://www.npmjs.com/package/decarg - Repository: https://git@github.com/stagas/decarg - Homepage: https://github.com/stagas/decarg#readme - Issues: https://github.com/stagas/decarg/issues - npm.io page: https://npm.io/package/decarg ## Dependencies (1) - [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.13 ## Alternatives - [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads - [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads - [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads - [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads - [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads ## Recent versions - 1.3.0 (latest) — 2022-08-21 - 1.2.1 — 2022-07-30 - 1.2.0 — 2022-03-16 - 1.1.0 — 2021-12-21 - 1.0.2 — 2021-12-13 - 1.0.1 — 2021-11-13 - 1.0.0 — 2021-11-13 ## README

decarg

decorator based cli arguments parser

`npm i decarg` `pnpm add decarg` `yarn add decarg`

## Examples

# basic

# view source

example/basic.ts

```ts import { arg, decarg } from 'decarg' class Options { @arg(' [, decarg.]', 'Files to process') file!: string[] @arg('--', '[decarg.rest]', 'The rest of the arguments') passArgs = [] @arg('-f', '--flag', 'Flag about something') flag = false @arg('-c', '--count', 'How many times') count = 42 @arg('-C', 'Choose color', ['blue', 'red', 'yellow']) color = 'blue' @arg('-s', '--string', 'Some string') string = 'hmm' @arg('--meh', 'Meh') meh: string[] = [] static examples = { '-f foo': 'Convert foo by force', '-f foo -s': 'Convert foo by force smoothly', } } const options = decarg(new Options()) // these fail: // const options = decarg(new Options(), ['exec']) // const options = decarg(new Options(), ['exec', '-C']) // const options = decarg(new Options(), ['exec', '-C=green']) // const options = decarg(new Options(), ['exec', '-c=not a number']) // this passes: // const options = decarg(new Options(), ['exec', 'foo']) console.log(options) ```

## API

# OptionExpectedValueError

src/errors.ts#L20

# constructor(option)

src/errors.ts#L22

# new OptionExpectedValueError()

OptionExpectedValueError<T>

# option

Option<T>

# option

src/errors.ts#L21

Option<T>

# prepareStackTrace

# (err, stackTraces)

# err

Error

# stackTraces

CallSite []

(err, stackTraces) =>

any

# stackTraceLimit

number

# captureStackTrace(targetObject, constructorOpt)

# targetObject

object

# constructorOpt

Function

captureStackTrace(targetObject, constructorOpt) =>

void

# OptionHelpRequested

src/errors.ts#L49

# constructor(options)

src/errors.ts#L50

# new OptionHelpRequested()

OptionHelpRequested<T>

# options

Options<T>

# prepareStackTrace

# (err, stackTraces)

# err

Error

# stackTraces

CallSite []

(err, stackTraces) =>

any

# stackTraceLimit

number

# captureStackTrace(targetObject, constructorOpt)

# targetObject

object

# constructorOpt

Function

captureStackTrace(targetObject, constructorOpt) =>

void

# OptionInvalidValueError

src/errors.ts#L35

# constructor(option, value)

src/errors.ts#L37

# new OptionInvalidValueError()

OptionInvalidValueError<T>

# option

Option<T>

# value

unknown

# option

src/errors.ts#L36

Option<T>

# prepareStackTrace

# (err, stackTraces)

# err

Error

# stackTraces

CallSite []

(err, stackTraces) =>

any

# stackTraceLimit

number

# captureStackTrace(targetObject, constructorOpt)

# targetObject

object

# constructorOpt

Function

captureStackTrace(targetObject, constructorOpt) =>

void

# OptionValidationError

src/errors.ts#L8

# constructor(message)

src/errors.ts#L9

# new OptionValidationError()

OptionValidationError

# message

string

# prepareStackTrace

# (err, stackTraces)

# err

Error

# stackTraces

CallSite []

(err, stackTraces) =>

any

# stackTraceLimit

number

# captureStackTrace(targetObject, constructorOpt)

# targetObject

object

# constructorOpt

Function

captureStackTrace(targetObject, constructorOpt) =>

void

# arg(description)

src/arg.ts#L7

# description

ArgDescription

arg(description) =>

# target

Function

(target) =>

void

# target

Object

# propertyKey

string | symbol

(target, propertyKey) =>

void

# decarg(target, argv, { exit, log })

src/index.ts#L17

# target

# argv = ...

string []

# overrides = {}

{

# exit

undefined |

# (code)

# code

number

(code) =>

never

# log

undefined | {

# data

any []

(data) =>

void

# data

any []

(data) =>

void

# message

any

# optionalParams

any []

(message, optionalParams) =>

void

decarg<T>(target, argv, { exit, log }) =>

# parse(target, argv)

src/parse.ts#L17

# target

# argv = ...

string []

parse<T>(target, argv) =>

## Credits - [reflect-metadata](https://npmjs.org/package/reflect-metadata) by [Ron Buckton](https://github.com/github.com) – Polyfill for Metadata Reflection API ## Contributing [Fork](https://github.com/stagas/decarg/fork) or [edit](https://github.dev/stagas/decarg) and submit a PR. All contributions are welcome! ## License MIT © 2022 [stagas](https://github.com/stagas) --- _Source: https://npm.io/package/decarg · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._

decarg

npm i decarg pnpm add decarg yarn add decarg

`npm i decarg` `pnpm add decarg` `yarn add decarg`