Home > @microsoft/api-extractor-model > ApiItem > canonicalReference

ApiItem.canonicalReference property

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Warning: This API is used internally by API extractor but is not yet ready for general usage.

Signature:

readonly canonicalReference: DeclarationReference;

Remarks

Returns a DeclarationReference object using the experimental new declaration reference notation.