cxx-frontend
    Preparing search index...

    Interface ServeOptions

    The options of LanguageServer.serve.

    interface ServeOptions {
        appdir?: string;
        defines?: string[];
        exists?: (path: string) => boolean;
        includePaths?: string[];
        onTrace?: (message: string, verbose?: string) => void;
        port: MessagePortLike;
        preamble?: boolean;
        quoteIncludePaths?: string[];
        readFile?: (path: string) => Promise<string | undefined>;
        std?: "c++14" | "c++17" | "c++20" | "c++23" | "c++26";
        sysroot?: string;
        systemIncludePaths?: string[];
        undefines?: string[];
        onMessage?(message: JsonRpcMessage): void;
    }

    Hierarchy

    Index
    appdir? defines? exists? includePaths? onTrace? port preamble? quoteIncludePaths? readFile? std? sysroot? systemIncludePaths? undefines?
    onMessage?
    appdir?: string
    defines?: string[]
    exists?: (path: string) => boolean
    includePaths?: string[]
    onTrace?: (message: string, verbose?: string) => void

    Type Declaration

      • (message: string, verbose?: string): void

      • Receives parser queue, phase, cancellation and code generation timings.

        Parameters

        • message: string
        • Optionalverbose: string

        Returns void

    port: MessagePortLike

    The endpoint the server reads the messages from and writes them to.

    preamble?: boolean

    Cache leading literal include directives as an in-memory PCH. Defaults to true. Body edits reuse the preamble; changing includes or closing the document discards it. Send workspace/didChangeWatchedFiles when header contents change.

    quoteIncludePaths?: string[]
    readFile?: (path: string) => Promise<string | undefined>
    std?: "c++14" | "c++17" | "c++20" | "c++23" | "c++26"
    sysroot?: string
    systemIncludePaths?: string[]
    undefines?: string[]

    Settings
    Member Visibility

    On This Page
    Properties
    Methods