@types/yargs-parser

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);