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

ExcerptToken class

Represents a fragment of text belonging to an Excerpt object.

Signature:

export declare class ExcerptToken 

Constructors

Constructor Modifiers Description
(constructor)(kind, text, canonicalReference)   Constructs a new instance of the ExcerptToken class

Properties

Property Modifiers Type Description
canonicalReference   DeclarationReference | undefined The hyperlink target for a token whose type is ExcerptTokenKind.Reference. For other token types, this property will be undefined.
kind   ExcerptTokenKind Indicates the kind of token.
text   string The text fragment.