Socket
Socket
Sign inDemoInstall

cli-argv-parser

Package Overview
Dependencies
0
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    cli-argv-parser

A library that allows to parse command line arguments into hash-table or object by scheme


Version published
Weekly downloads
8
increased by60%
Maintainers
1
Install size
5.85 kB
Created
Weekly downloads
 

Readme

Source

Command Line Argumets Parser

A library that allows to parse command line arguments into hash-table or object by scheme.

Installation

Install library to your project:

$ npm install cli-argv-parser

How to use

You able to put only arguments array to parser and it will be return a hash-table (key-value). But if you want to parse arguments into object - use template scheme with keys and required types.

Scheme:

const scheme = {
    file: String,
    force: Boolean,
    count: Number,
}

The template is key: type. Parser will try to convert argument into required type. By default single values will be always parsed into Boolean value.

Example of result:

  • Without scheme: { '--file': 'app.js', force: true, '--count': '20' }
  • With scheme: { file: 'app.js', force: true, count: 20 }

Author

Yehor Bublyk: GitHubTwitter

Keywords

FAQs

Last updated on 06 Feb 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc