Class Emitter

    Package: grammarkdown

    Constructors

    constructor(options)

    Constructs a new instance of the Emitter class

    Declaration
    constructor(options: CompilerOptions);
    Parameters
    options
    CompilerOptions

    Properties

    extension

    Declaration
    protected extension: string;
    Property Value
    string

    options

    Declaration
    protected options: CompilerOptions;
    Property Value
    CompilerOptions

    resolver

    Declaration
    protected resolver: Resolver;
    Property Value
    Resolver

    sourceFile

    Declaration
    protected get sourceFile(): SourceFile | undefined;
    Property Value
    SourceFile | undefined

    writer

    Declaration
    protected writer: StringWriter;
    Property Value
    StringWriter

    Methods

    afterEmitNode(node)

    Declaration
    protected afterEmitNode(node: Node): void;
    Parameters
    node
    Node

    Returns
    void

    afterEmitTrivia(node)

    Declaration
    protected afterEmitTrivia(node: Trivia): void;
    Parameters
    node
    Trivia

    Returns
    void

    beforeEmitNode(node)

    Declaration
    protected beforeEmitNode(node: Node): void;
    Parameters
    node
    Node

    Returns
    void

    beforeEmitTrivia(node)

    Declaration
    protected beforeEmitTrivia(node: Trivia): void;
    Parameters
    node
    Trivia

    Returns
    void

    createWriter(options)

    Declaration
    protected createWriter(options: CompilerOptions): StringWriter;
    Parameters
    options
    CompilerOptions

    Returns
    StringWriter

    emit(node, resolver, diagnostics, writeFile, cancelable)

    Declaration
    emit(node: SourceFile, resolver: Resolver, diagnostics: DiagnosticMessages, writeFile: (file: string, text: string, cancelToken?: CancelToken) => void | PromiseLike<void>, cancelable?: Cancelable): Promise<void>;
    Parameters
    node
    SourceFile

    resolver
    Resolver

    diagnostics
    DiagnosticMessages

    writeFile
    (file: string, text: string, cancelToken?: CancelToken) => void | PromiseLike<void>

    cancelable
    Cancelable

    Returns
    Promise<void>

    emitArgument(node)

    Declaration
    protected emitArgument(node: Argument): void;
    Parameters
    node
    Argument

    Returns
    void

    emitArgumentList(node)

    Declaration
    protected emitArgumentList(node: ArgumentList): void;
    Parameters
    node
    ArgumentList

    Returns
    void

    emitButNotSymbol(node)

    Declaration
    protected emitButNotSymbol(node: ButNotSymbol): void;
    Parameters
    node
    ButNotSymbol

    Returns
    void

    emitChildren(node)

    Declaration
    protected emitChildren(node: Node): void;
    Parameters
    node
    Node

    Returns
    void

    emitConstraints(node)

    Declaration
    protected emitConstraints(node: Constraints): void;
    Parameters
    node
    Constraints

    Returns
    void

    emitDefine(node)

    Declaration
    protected emitDefine(node: Define): void;
    Parameters
    node
    Define

    Returns
    void

    emitDetachedTriviaOfNode(node)

    Declaration
    protected emitDetachedTriviaOfNode(node: Node): void;
    Parameters
    node
    Node

    Returns
    void

    emitEmptyAssertion(node)

    Declaration
    protected emitEmptyAssertion(node: EmptyAssertion): void;
    Parameters
    node
    EmptyAssertion

    Returns
    void

    emitHtmlCloseTagTrivia(node)

    Declaration
    protected emitHtmlCloseTagTrivia(node: HtmlCloseTagTrivia): void;
    Parameters
    node
    HtmlCloseTagTrivia

    Returns
    void

    emitHtmlCommentTrivia(node)

    Declaration
    protected emitHtmlCommentTrivia(node: HtmlCommentTrivia): void;
    Parameters
    node
    HtmlCommentTrivia

    Returns
    void

    emitHtmlOpenTagTrivia(node)

    Declaration
    protected emitHtmlOpenTagTrivia(node: HtmlOpenTagTrivia): void;
    Parameters
    node
    HtmlOpenTagTrivia

    Returns
    void

    emitIdentifier(node)

    Declaration
    protected emitIdentifier(node: Identifier): void;
    Parameters
    node
    Identifier

    Returns
    void

    emitImport(node)

    Declaration
    protected emitImport(node: Import): void;
    Parameters
    node
    Import

    Returns
    void

    emitKeyword(node)

    Declaration
    protected emitKeyword(node: Node): void;
    Parameters
    node
    Node

    Returns
    void

    emitLeadingTriviaOfNode(node)

    Declaration
    protected emitLeadingTriviaOfNode(node: Node): void;
    Parameters
    node
    Node

    Returns
    void

    emitLexicalGoalAssertion(node)

    Declaration
    protected emitLexicalGoalAssertion(node: LexicalGoalAssertion): void;
    Parameters
    node
    LexicalGoalAssertion

    Returns
    void

    emitLine(node)

    Declaration
    protected emitLine(node: Line): void;
    Parameters
    node
    Line

    Returns
    void

    emitLinkReference(node)

    Declaration
    protected emitLinkReference(node: LinkReference): void;
    Parameters
    node
    LinkReference

    Returns
    void

    emitLookaheadAssertion(node)

    Declaration
    protected emitLookaheadAssertion(node: LookaheadAssertion): void;
    Parameters
    node
    LookaheadAssertion

    Returns
    void

    emitMultiLineCommentTrivia(node)

    Declaration
    protected emitMultiLineCommentTrivia(node: MultiLineCommentTrivia): void;
    Parameters
    node
    MultiLineCommentTrivia

    Returns
    void

    emitNode(node)

    Declaration
    protected emitNode(node: Node | undefined): void;
    Parameters
    node
    Node | undefined

    Returns
    void

    emitNodeCore(node)

    Declaration
    protected emitNodeCore(node: Node): void;
    Parameters
    node
    Node

    Returns
    void

    emitNodes(nodes)

    Declaration
    protected emitNodes(nodes: Iterable<Node>): void;
    Parameters
    nodes
    Iterable<Node>

    Returns
    void

    emitNonterminal(node)

    Declaration
    protected emitNonterminal(node: Nonterminal): void;
    Parameters
    node
    Nonterminal

    Returns
    void

    emitNoSymbolHereAssertion(node)

    Declaration
    protected emitNoSymbolHereAssertion(node: NoSymbolHereAssertion): void;
    Parameters
    node
    NoSymbolHereAssertion

    Returns
    void

    emitNumberLiteral(node)

    Declaration
    protected emitNumberLiteral(node: NumberLiteral): void;
    Parameters
    node
    NumberLiteral

    Returns
    void

    emitOneOfList(node)

    Declaration
    protected emitOneOfList(node: OneOfList): void;
    Parameters
    node
    OneOfList

    Returns
    void

    emitOneOfSymbol(node)

    Declaration
    protected emitOneOfSymbol(node: OneOfSymbol): void;
    Parameters
    node
    OneOfSymbol

    Returns
    void

    emitParameter(node)

    Declaration
    protected emitParameter(node: Parameter): void;
    Parameters
    node
    Parameter

    Returns
    void

    emitParameterList(node)

    Declaration
    protected emitParameterList(node: ParameterList): void;
    Parameters
    node
    ParameterList

    Returns
    void

    emitPlaceholder(node)

    Declaration
    protected emitPlaceholder(node: PlaceholderSymbol): void;
    Parameters
    node
    PlaceholderSymbol

    Returns
    void

    emitProduction(node)

    Declaration
    protected emitProduction(node: Production): void;
    Parameters
    node
    Production

    Returns
    void

    emitProse(node)

    Declaration
    protected emitProse(node: Prose): void;
    Parameters
    node
    Prose

    Returns
    void

    emitProseAssertion(node)

    Declaration
    protected emitProseAssertion(node: ProseAssertion): void;
    Parameters
    node
    ProseAssertion

    Returns
    void

    emitProseFragmentLiteral(node)

    Declaration
    protected emitProseFragmentLiteral(node: ProseFragmentLiteral): void;
    Parameters
    node
    ProseFragmentLiteral

    Returns
    void

    emitRightHandSide(node)

    Declaration
    protected emitRightHandSide(node: RightHandSide): void;
    Parameters
    node
    RightHandSide

    Returns
    void

    emitRightHandSideList(node)

    Declaration
    protected emitRightHandSideList(node: RightHandSideList): void;
    Parameters
    node
    RightHandSideList

    Returns
    void

    emitSingleLineCommentTrivia(node)

    Declaration
    protected emitSingleLineCommentTrivia(node: SingleLineCommentTrivia): void;
    Parameters
    node
    SingleLineCommentTrivia

    Returns
    void

    emitSourceFile(node)

    Declaration
    protected emitSourceFile(node: SourceFile): void;
    Parameters
    node
    SourceFile

    Returns
    void

    emitString(sourceFile, resolver, diagnostics, cancelable, node)

    Declaration
    emitString(sourceFile: SourceFile, resolver: Resolver, diagnostics: DiagnosticMessages, cancelable?: Cancelable, node?: Node): string;
    Parameters
    sourceFile
    SourceFile

    resolver
    Resolver

    diagnostics
    DiagnosticMessages

    cancelable
    Cancelable

    node
    Node

    Returns
    string

    emitStringLiteral(node)

    Declaration
    protected emitStringLiteral(node: StringLiteral): void;
    Parameters
    node
    StringLiteral

    Returns
    void

    emitSymbolSet(node)

    Declaration
    protected emitSymbolSet(node: SymbolSet): void;
    Parameters
    node
    SymbolSet

    Returns
    void

    emitSymbolSpan(node)

    Declaration
    protected emitSymbolSpan(node: SymbolSpan): void;
    Parameters
    node
    SymbolSpan

    Returns
    void

    emitTerminal(node)

    Declaration
    protected emitTerminal(node: Terminal): void;
    Parameters
    node
    Terminal

    Returns
    void

    emitTerminalLiteral(node)

    Declaration
    protected emitTerminalLiteral(node: TerminalLiteral): void;
    Parameters
    node
    TerminalLiteral

    Returns
    void

    emitTextContent(node)

    Declaration
    protected emitTextContent(node: TextContent): void;
    Parameters
    node
    TextContent

    Returns
    void

    emitTextRange(range)

    Declaration
    protected emitTextRange(range: TextRange): void;
    Parameters
    range
    TextRange

    Returns
    void

    emitToken(node)

    Declaration
    protected emitToken(node: Node | undefined): void;
    Parameters
    node
    Node | undefined

    Returns
    void

    emitTokenKind(kind)

    Declaration
    protected emitTokenKind(kind: SyntaxKind): void;
    Parameters
    kind
    SyntaxKind

    Returns
    void

    emitTrailingTriviaOfNode(node)

    Declaration
    protected emitTrailingTriviaOfNode(node: Node): void;
    Parameters
    node
    Node

    Returns
    void

    emitTrivia(node)

    Declaration
    protected emitTrivia(node: Trivia): void;
    Parameters
    node
    Trivia

    Returns
    void

    emitTriviaCore(node)

    Declaration
    protected emitTriviaCore(node: Trivia): void;
    Parameters
    node
    Trivia

    Returns
    void

    emitTriviaNodes(nodes)

    Declaration
    protected emitTriviaNodes(nodes: readonly Trivia[] | undefined): void;
    Parameters
    nodes
    readonly Trivia[] | undefined

    Returns
    void

    emitUnicodeCharacterLiteral(node)

    Declaration
    protected emitUnicodeCharacterLiteral(node: UnicodeCharacterLiteral): void;
    Parameters
    node
    UnicodeCharacterLiteral

    Returns
    void

    emitUnicodeCharacterRange(node)

    Declaration
    protected emitUnicodeCharacterRange(node: UnicodeCharacterRange): void;
    Parameters
    node
    UnicodeCharacterRange

    Returns
    void

    encode(text)

    Declaration
    protected encode(text: string): string;
    Parameters
    text
    string

    Returns
    string

    getOutputFilename(node)

    Declaration
    protected getOutputFilename(node: SourceFile): string;
    Parameters
    node
    SourceFile

    Returns
    string

    Generated by DocFX