@adonisjs/ace/build/src/parser.d.ts

A CLI framework for Node.js

import type { ParsedOutput, FlagsParserOptions, ArgumentsParserOptions } from './types.ts';
/**
 * Parses the command line arguments. The flags are parsed using yargs-parser
 *
 * @example
 * ```ts
 * const parser = new Parser({ flagsParserOptions, argumentsParserOptions })
 * const parsed = parser.parse(['--verbose', 'create', 'User'])
 * console.log(parsed.args) // ['User']
 * console.log(parsed.flags) // { verbose: true }
 * ```
 */
export declare class Parser {
    #private;
    /**
     * Create a new parser instance
     *
     * @param options - Parser configuration options
     */
    constructor(options: {
        flagsParserOptions: FlagsParserOptions;
        argumentsParserOptions: ArgumentsParserOptions[];
    });
    /**
     * Parse command-line arguments into structured format
     *
     * @param argv - Command line arguments as string or array
     *
     * @example
     * ```ts
     * const parsed = parser.parse(['--verbose', 'create', 'User'])
     * // Returns: { args: ['User'], flags: { verbose: true }, ... }
     * ```
     */
    parse(argv: string | string[]): ParsedOutput;
}