argparse-ts/es/utils/utils.d.ts

Modern CLI arguments parser for node.js

import type { ArgConfig, ArgExtraConfig } from "../types";
/**
 * Parses an array of command-line arguments into positional and optional arguments.
 *
 * @param argv - The array of command-line arguments.
 * @returns A tuple containing an array of positional arguments and a record of optional arguments.
 *
 * @category Utils
 *
 * @example
 * ```
 * const argv = ['make', '--flag', '-v', 'a', 'b', 'c'];
 * const [positional, optional] = parseArgsArray(argv);
 * console.log(positional); // ['make']
 * console.log(optional); // { '--flag': [], '-v': ['a', 'b', 'c'] }
 * ```
 */
export declare function parseArgsArray(argv: string[]): [string[], Record<string, string[]>];
/**
 * Formats the argument name with alias.
 *
 * @param argConfig - The argument configuration.
 *
 * @returns The formatted argument name.
 *
 * @category Utils
 */
export declare function formatArgNameWithAlias(argConfig: ArgConfig): string;
/**
 * Builds the extra configuration for an argument.
 *
 * @param config - The argument configuration.
 *
 * @returns The extra configuration.
 *
 * @category Utils
 */
export declare function buildArgExtraConfig(config: ArgConfig): ArgExtraConfig;