Show / Hide Table of Contents

    Class SyncSingleFileHost

    Inheritance
    HostBase
    SyncHost
    SyncSingleFileHost
    Package: grammarkdown

    Constructors

    (constructor)(file, content, hostFallback)

    Constructs a new instance of the SyncSingleFileHost class

    Declaration
    constructor(file: string, content: string, hostFallback?: SyncHost);
    Parameters
    Type Name Description
    string file
    string content
    SyncHost hostFallback

    Properties

    content

    Declaration
    readonly content: string;
    Property Value
    Type Description
    string

    file

    Declaration
    readonly file: string;
    Property Value
    Type Description
    string

    Methods

    normalizeFile(file)

    Declaration
    normalizeFile(file: string): string;
    Parameters
    Type Name Description
    string file
    Returns
    Type Description
    string

    readFileSync(file, cancelable)

    Declaration
    readFileSync(file: string, cancelable?: Cancelable): string | undefined;
    Parameters
    Type Name Description
    string file
    Cancelable cancelable
    Returns
    Type Description
    string | undefined

    readFileSync(file, cancelable)

    Declaration
    readFileSync(file: string, cancelable?: CancellationToken | Cancelable): string | undefined;
    Parameters
    Type Name Description
    string file
    CancellationToken | Cancelable cancelable
    Returns
    Type Description
    string | undefined

    resolveFile(file, referer)

    Declaration
    resolveFile(file: string, referer?: string): string;
    Parameters
    Type Name Description
    string file
    string referer
    Returns
    Type Description
    string

    writeFileSync(file, text, cancelable)

    Declaration
    writeFileSync(file: string, text: string, cancelable?: Cancelable): void;
    Parameters
    Type Name Description
    string file
    string text
    Cancelable cancelable
    Returns
    Type Description
    void

    writeFileSync(file, text, cancelable)

    Declaration
    writeFileSync(file: string, text: string, cancelable?: CancellationToken | Cancelable): void;
    Parameters
    Type Name Description
    string file
    string text
    CancellationToken | Cancelable cancelable
    Returns
    Type Description
    void
    Back to top Generated by DocFX