asciidoctor
    Preparing search index...

    Class Options

    Parses command-line arguments and builds Asciidoctor convert options. Extend this class to add custom options via Options#addOption.

    Index

    Constructors

    constructor

    Properties

    _definitions argv failureLevel options positionals stdin values

    Methods

    _buildConvertOptions addOption buildHelpText parse

    Constructors

    Properties

    Internal_definitions

    _definitions: {
        attribute: {
            describe: string;
            metavar: string;
            multiple: boolean;
            short: string;
            type: string;
        };
        backend: { describe: string; metavar: string; short: string; type: string };
        "base-dir": {
            describe: string;
            metavar: string;
            short: string;
            type: string;
        };
        "destination-dir": {
            describe: string;
            metavar: string;
            short: string;
            type: string;
        };
        doctype: { describe: string; metavar: string; short: string; type: string };
        embedded: { describe: string; short: string; type: string };
        "failure-level": { describe: string; metavar: string; type: string };
        help: { describe: string; metavar: string; type: string };
        "no-header-footer": { describe: string; short: string; type: string };
        "out-file": {
            describe: string;
            metavar: string;
            short: string;
            type: string;
        };
        quiet: { describe: string; short: string; type: string };
        require: {
            describe: string;
            metavar: string;
            multiple: boolean;
            short: string;
            type: string;
        };
        "safe-mode": {
            describe: string;
            metavar: string;
            short: string;
            type: string;
        };
        "section-numbers": { describe: string; short: string; type: string };
        "template-dir": {
            describe: string;
            metavar: string;
            multiple: boolean;
            short: string;
            type: string;
        };
        "template-engine": {
            describe: string;
            metavar: string;
            short: string;
            type: string;
        };
        timings: { describe: string; short: string; type: string };
        trace: { describe: string; type: string };
        verbose: { describe: string; short: string; type: string };
        version: { describe: string; short: string; type: string };
    }
    argv: string[]
    failureLevel: number
    options: any
    positionals: string[]
    stdin: boolean
    values: Record<string, unknown>

    Methods

    _buildConvertOptions

    • _buildConvertOptions(
          extraAttrs?: any[],
      ): {
          failureLevel: any;
          options: {
              attributes: any[];
              mkdirs: boolean;
              safe: unknown;
              standalone: boolean;
              timings: unknown;
              trace: unknown;
              verbose: number;
          };
      }
      Internal

      Parameters

      • OptionalextraAttrs: any[]

      Returns {
          failureLevel: any;
          options: {
              attributes: any[];
              mkdirs: boolean;
              safe: unknown;
              standalone: boolean;
              timings: unknown;
              trace: unknown;
              verbose: number;
          };
      }

    • Build the help text from all registered option definitions.

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods