# process-argvs

> 计算 node process 脚本参数

Latest version **0.0.3** (published 2020-07-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install process-argvs
pnpm add process-argvs
yarn add process-argvs
bun add process-argvs
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2020-07-08 |
| First published | 2020-07-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Pyrine.Law |
| Maintainers | pyrinelaw |
| Keywords | process-argvs, process, argvs, require-argvs |

## Links

- npm: https://www.npmjs.com/package/process-argvs
- Repository: https://github.com/pyrinelaw/process-argvs
- Homepage: https://github.com/pyrinelaw/process-argvs#readme
- Issues: https://github.com/pyrinelaw/process-argvs/issues
- npm.io page: https://npm.io/package/process-argvs

## Recent versions

- 0.0.3 (latest) — 2020-07-08
- 0.0.2 — 2020-07-08
- 0.0.1 — 2020-07-08

## README

## process-argvs

计算 node process 脚本参数

### 使用示例

```javascript
// 调用语句示例: node test/index.js -a a -b b -c c1 c2 c3 -d d1 d2

const processArgvs = require('process-argvs');

processArgvs({
    prefix: '-',
    requireAll: true,
    require: {
        a: String,
        b: Boolean,
        c: Array
    } 
});

// return 
{ 
    data: { 
        a: 'a', 
        b: true, 
        c: [ 'c1', 'c2', 'c3' ], 
        d: 'd1' 
    },
    first: { 
        key: 'a', 
        value: 'a' 
    } 
}

```

### 参数说明
参数     | 类型 | 是否必传 | 默认值 | 说明
-------- | --- | --- | --- | ---
prefix | String | 否 | - | 参数前缀，默认为“-”，也可以使用 “--”，或者其他前缀
requireAll | Boolean | 否 | true | 是否获取所有参数，设置为 false 后只会返回包含在 require 中的参数据
require | Object | 否 | undefined | 包含数据类型，键值对形式，值支持 String/Boolean/Array

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