Show / Hide Table of Contents

    Class Host

    Package: grammarkdown
    Warning

    Deprecated

    Use `SyncHost` or `AsyncHost` instead
    Inheritance
    HostBase
    Host

    Constructors

    constructor(options)

    Warning

    Deprecated

    Use `SyncHost` or `AsyncHost` instead

    Constructs a new instance of the Host class

    Declaration
    constructor(options?: HostOptions);
    Parameters
    options
    HostOptions

    Methods

    getSourceFile(file, cancelable)

    Warning

    Deprecated

    Use `SyncHost` or `AsyncHost` instead
    Declaration
    getSourceFile(file: string, cancelable?: Cancelable): Promise<SourceFile | undefined>;
    Parameters
    file
    string

    cancelable
    Cancelable

    Returns
    Promise<SourceFile | undefined>

    getSourceFile(file, cancelable)

    Warning

    Deprecated

    since 2.1.0 - `prex.CancellationToken` may no longer be accepted in future releases. Please use a token that implements `@esfx/cancelable.Cancelable`
    Declaration
    getSourceFile(file: string, cancelable?: CancellationToken | Cancelable): Promise<SourceFile | undefined>;
    Parameters
    file
    string

    cancelable
    CancellationToken | Cancelable

    Returns
    Promise<SourceFile | undefined>

    getSourceFileSync(file, cancelable)

    Warning

    Deprecated

    Use `SyncHost` or `AsyncHost` instead
    Declaration
    getSourceFileSync(file: string, cancelable?: Cancelable): SourceFile | undefined;
    Parameters
    file
    string

    cancelable
    Cancelable

    Returns
    SourceFile | undefined

    getSourceFileSync(file, cancelable)

    Warning

    Deprecated

    since 2.1.0 - `prex.CancellationToken` may no longer be accepted in future releases. Please use a token that implements `@esfx/cancelable.Cancelable`
    Declaration
    getSourceFileSync(file: string, cancelable?: CancellationToken | Cancelable): SourceFile | undefined;
    Parameters
    file
    string

    cancelable
    CancellationToken | Cancelable

    Returns
    SourceFile | undefined

    readFile(file, cancelable)

    Warning

    Deprecated

    Use `SyncHost` or `AsyncHost` instead
    Declaration
    readFile(file: string, cancelable?: Cancelable): Promise<string | undefined>;
    Parameters
    file
    string

    cancelable
    Cancelable

    Returns
    Promise<string | undefined>

    readFile(file, cancelable)

    Warning

    Deprecated

    since 2.1.0 - `prex.CancellationToken` may no longer be accepted in future releases. Please use a token that implements `@esfx/cancelable.Cancelable`
    Declaration
    readFile(file: string, cancelable?: CancellationToken | Cancelable): Promise<string | undefined>;
    Parameters
    file
    string

    cancelable
    CancellationToken | Cancelable

    Returns
    Promise<string | undefined>

    readFileSync(file, cancelable)

    Warning

    Deprecated

    Use `SyncHost` or `AsyncHost` instead
    Declaration
    readFileSync(file: string, cancelable?: Cancelable): string | undefined;
    Parameters
    file
    string

    cancelable
    Cancelable

    Returns
    string | undefined

    readFileSync(file, cancelable)

    Warning

    Deprecated

    since 2.1.0 - `prex.CancellationToken` may no longer be accepted in future releases. Please use a token that implements `@esfx/cancelable.Cancelable`
    Declaration
    readFileSync(file: string, cancelable?: CancellationToken | Cancelable): string | undefined;
    Parameters
    file
    string

    cancelable
    CancellationToken | Cancelable

    Returns
    string | undefined

    resolveFileCore(file, referer)

    Warning

    Deprecated

    Use `SyncHost` or `AsyncHost` instead
    Declaration
    protected resolveFileCore(file: string, referer?: string): string;
    Parameters
    file
    string

    referer
    string

    Returns
    string

    writeFile(file, text, cancelable)

    Warning

    Deprecated

    Use `SyncHost` or `AsyncHost` instead
    Declaration
    writeFile(file: string, text: string, cancelable?: Cancelable): Promise<void>;
    Parameters
    file
    string

    text
    string

    cancelable
    Cancelable

    Returns
    Promise<void>

    writeFile(file, text, cancelable)

    Warning

    Deprecated

    since 2.1.0 - `prex.CancellationToken` may no longer be accepted in future releases. Please use a token that implements `@esfx/cancelable.Cancelable`
    Declaration
    writeFile(file: string, text: string, cancelable?: CancellationToken | Cancelable): Promise<void>;
    Parameters
    file
    string

    text
    string

    cancelable
    CancellationToken | Cancelable

    Returns
    Promise<void>

    writeFileSync(file, text, cancelable)

    Warning

    Deprecated

    Use `SyncHost` or `AsyncHost` instead
    Declaration
    writeFileSync(file: string, text: string, cancelable?: Cancelable): void;
    Parameters
    file
    string

    text
    string

    cancelable
    Cancelable

    Returns
    void

    writeFileSync(file, text, cancelable)

    Warning

    Deprecated

    since 2.1.0 - `prex.CancellationToken` may no longer be accepted in future releases. Please use a token that implements `@esfx/cancelable.Cancelable`
    Declaration
    writeFileSync(file: string, text: string, cancelable?: CancellationToken | Cancelable): void;
    Parameters
    file
    string

    text
    string

    cancelable
    CancellationToken | Cancelable

    Returns
    void

    Back to top Generated by DocFX