RoadmapShopEvents
Skip to main content

Home > @microsoft/api-extractor-model > ExcerptToken

ExcerptToken class

Represents a fragment of text belonging to an Excerpt object.

Signature:
export declare class ExcerptToken

Constructors

ConstructorModifiersDescription
(constructor)(kind, text, canonicalReference)Constructs a new instance of the ExcerptToken class

Properties

PropertyModifiersTypeDescription
canonicalReferenceDeclarationReference | undefinedThe hyperlink target for a token whose type is ExcerptTokenKind.Reference. For other token types, this property will be undefined.
kindExcerptTokenKindIndicates the kind of token.
textstringThe text fragment.