Show / Hide Table of Contents

    Interface CoreAsyncHostOptions

    Package: grammarkdown

    Options used to configure a CoreAsyncHost.

    Properties

    ignoreCase

    Indicates whether the host is case-insensitive (true) or case-sensitive (false).

    Declaration
    ignoreCase?: boolean;
    Property Value
    boolean

    knownGrammars

    A set of known grammars in the form { "name": "path" }

    Declaration
    knownGrammars?: Record<string, string>;
    Property Value
    Record<string, string>

    normalizeFile

    A callback used to control file normalization when generating keys for maps based on the case sensitivity of the host.

    Declaration
    normalizeFile?: (this: void, file: string, fallback: (file: string) => string) => string;
    Property Value
    (this: void, file: string, fallback: (file: string) => string) => string

    readFile

    A callback used to control asynchronous file reads.

    Declaration
    readFile?: (this: void, file: string, cancelToken: CancelToken | undefined, fallback: (file: string, cancelToken?: CancelToken) => Promise<string | undefined>) => PromiseLike<string | undefined> | string | undefined;
    Property Value
    (this: void, file: string, cancelToken: CancelToken | undefined, fallback: (file: string, cancelToken?: CancelToken) => Promise<string | undefined>) => PromiseLike<string | undefined> | string | undefined

    resolveFile

    A callback used to control file resolution.

    Declaration
    resolveFile?: (this: void, file: string, referer: string | undefined, fallback: (file: string, referer?: string) => string) => string;
    Property Value
    (this: void, file: string, referer: string | undefined, fallback: (file: string, referer?: string) => string) => string

    resolveKnownGrammar

    A callback used to control known grammar resolution.

    Declaration
    resolveKnownGrammar?: (this: void, name: string, fallback: (name: string) => string | undefined) => string | undefined;
    Property Value
    (this: void, name: string, fallback: (name: string) => string | undefined) => string | undefined

    useBuiltinGrammars

    Indicates whether to include builtin grammars in the set of known grammars.

    Declaration
    useBuiltinGrammars?: boolean;
    Property Value
    boolean

    writeFile

    A callback used to control asynchronous file writes.

    Declaration
    writeFile?: (this: void, file: string, content: string, cancelToken: CancelToken | undefined, fallback: (file: string, content: string, cancelToken?: CancelToken) => Promise<void>) => PromiseLike<void> | void;
    Property Value
    (this: void, file: string, content: string, cancelToken: CancelToken | undefined, fallback: (file: string, content: string, cancelToken?: CancelToken) => Promise<void>) => PromiseLike<void> | void

    • Improve this Doc
    Back to top Generated by DocFX