cxx-frontend
    Preparing search index...

    Interface ParseOptions

    interface ParseOptions {
        appdir?: string;
        debugInfo?: boolean;
        defines?: string[];
        exists?: (path: string) => boolean;
        includePaths?: string[];
        path: string;
        quoteIncludePaths?: string[];
        readFile?: (path: string) => Promise<string | undefined>;
        signal?: AbortSignal;
        source: string;
        std?: "c++14" | "c++17" | "c++20" | "c++23" | "c++26";
        sysroot?: string;
        systemIncludePaths?: string[];
        undefines?: string[];
    }

    Hierarchy

    • Omit<UnitOptions, "shouldContinue">
      • ParseOptions
    Index
    appdir? debugInfo? defines? exists? includePaths? path quoteIncludePaths? readFile? signal? source std? sysroot? systemIncludePaths? undefines?
    appdir?: string
    debugInfo?: boolean
    defines?: string[]
    exists?: (path: string) => boolean
    includePaths?: string[]
    path: string

    Path to the file to parse.

    quoteIncludePaths?: string[]
    readFile?: (path: string) => Promise<string | undefined>
    signal?: AbortSignal

    Aborts preprocessing and parsing.

    When the signal is aborted Parser.parse rejects with signal.reason and no translation unit is returned.

    The wasm module runs on the JavaScript thread, so preprocessing and parsing periodically yield to the event loop to give the signal a chance to be aborted. Passing a signal therefore makes the work asynchronous, a parse without one runs to completion without interruption.

    source: string

    Source code to parse.

    std?: "c++14" | "c++17" | "c++20" | "c++23" | "c++26"
    sysroot?: string
    systemIncludePaths?: string[]
    undefines?: string[]

    Settings
    Member Visibility

    On This Page
    Properties