Interface JSDocTagStructure

interface JSDocTagStructure {
    kind: JSDocTag;
    leadingTrivia?: string | WriterFunction | (string | WriterFunction)[];
    tagName: string;
    text?: string | WriterFunction;
    trailingTrivia?: string | WriterFunction | (string | WriterFunction)[];
}

Hierarchy (View Summary)

Structure
JSDocTagSpecificStructure
- JSDocTagStructure

Index

Properties

kind leadingTrivia? tagName text? trailingTrivia?

Properties

kind

`Optional`leadingTrivia

leadingTrivia?: string | WriterFunction | (string | WriterFunction)[]

Leading comments or whitespace.

tagName

tagName: string

The name for the JS doc tag that comes after the "at" symbol.

`Optional`text

text?: string | WriterFunction

The text that follows the tag name.

`Optional`trailingTrivia

trailingTrivia?: string | WriterFunction | (string | WriterFunction)[]

Trailing comments or whitespace.