@types/yargs-parser

What is @types/yargs-parser?

The @types/yargs-parser package provides TypeScript type definitions for the yargs-parser package, which is a tool for parsing command line arguments. These type definitions allow TypeScript developers to use yargs-parser in their projects with the benefits of TypeScript's static typing. This helps in catching errors early in the development process and improves code quality and maintainability.

What are @types/yargs-parser's main functionalities?

Parsing command line arguments

This feature allows you to parse command line arguments. The code sample demonstrates how to import yargs-parser and use it to parse arguments from the command line. The parsed arguments are then logged to the console.

import yargsParser from 'yargs-parser';
const argv = yargsParser(process.argv.slice(2));
console.log(argv);

Typed Configuration Options

This feature leverages TypeScript's static typing for configuration options. The code sample shows how to define an interface for the expected options and use it to type the parsed arguments, providing autocompletion and type checking.

import yargsParser, { Arguments } from 'yargs-parser';
interface MyOptions {
  verbose: boolean;
  src: string;
}
const argv: Arguments<MyOptions> = yargsParser(process.argv.slice(2));
console.log(argv.verbose, argv.src);

Other packages similar to @types/yargs-parser

commander

Commander is a complete solution for node.js command-line interfaces, offering more high-level features out of the box compared to yargs-parser, such as automatic help generation, command-based syntax, and option parsing. It does not require separate type definitions as it is written in TypeScript.

minimist

Minimist is a minimalist option parsing library similar to yargs-parser but with a simpler API and smaller footprint. It focuses solely on parsing command line arguments without additional features like command handling or automatic help text generation. Separate TypeScript definitions are available but not bundled.

README

Installation

npm install --save @types/yargs-parser

Summary

This package contains type definitions for yargs-parser (https://github.com/yargs/yargs-parser#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/yargs-parser.

Additional Details

• Last updated: Tue, 07 Nov 2023 21:36:25 GMT
• Dependencies: none

Credits

These definitions were written by Miles Johnson.