Class Prose

    Package: grammarkdown

    Represents a section of Prose, which indicates handling of syntax outside the scope of the Grammarkdown parser.

    > This is a section of Prose with |Nonterminals| and `terminals`
    
    Inheritance
    LexicalSymbolBase<SyntaxKind.Prose>
    Prose

    Constructors

    constructor(greaterThanToken, fragments)

    Constructs a new instance of the Prose class

    Declaration
    constructor(greaterThanToken: Token<SyntaxKind.GreaterThanToken>, fragments: ReadonlyArray<ProseFragment> | undefined);
    Parameters
    greaterThanToken
    Token<SyntaxKind.GreaterThanToken>

    fragments
    ReadonlyArray<ProseFragment> | undefined

    Properties

    firstChild

    Declaration
    get firstChild(): Node | undefined;
    Property Value
    Node | undefined

    fragments

    Declaration
    readonly fragments: ReadonlyArray<ProseFragment> | undefined;
    Property Value
    ReadonlyArray<ProseFragment> | undefined

    greaterThanToken

    Declaration
    readonly greaterThanToken: Token<SyntaxKind.GreaterThanToken>;
    Property Value
    Token<SyntaxKind.GreaterThanToken>

    lastChild

    Declaration
    get lastChild(): Node | undefined;
    Property Value
    Node | undefined

    Methods

    children()

    Declaration
    children(): IterableIterator<Node>;
    Returns
    IterableIterator<Node>

    forEachChild(cbNode)

    Declaration
    forEachChild<T>(cbNode: (node: Node) => T | undefined): T | undefined;
    Type Parameters
    T

    Parameters
    cbNode
    (node: Node) => T | undefined

    Returns
    T | undefined

    update(fragments)

    Declaration
    update(fragments: ReadonlyArray<ProseFragment> | undefined): Prose;
    Parameters
    fragments
    ReadonlyArray<ProseFragment> | undefined

    Returns
    Prose

    Generated by DocFX