Skip to main content

parseArgs

function parseArgs
Jump to headingparseArgs<T extends ParseArgsConfig>(config?: T): ParsedResults<T>

Provides a higher level API for command-line argument parsing than interacting with process.argv directly. Takes a specification for the expected arguments and returns a structured object with the parsed options and positionals.

import { parseArgs } from 'node:util';
const args = ['-f', '--bar', 'b'];
const options = {
  foo: {
    type: 'boolean',
    short: 'f',
  },
  bar: {
    type: 'string',
  },
};
const {
  values,
  positionals,
} = parseArgs({ args, options });
console.log(values, positionals);
// Prints: [Object: null prototype] { foo: true, bar: 'b' } []

Type Parameters Jump to heading

Parameters Jump to heading

optional
Jump to headingconfig: T

Used to provide arguments for parsing and to configure the parser. config supports the following properties:

Return Type Jump to heading

The parsed command line arguments:

Back to top