RoadmapShopEvents
Skip to main content

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

ApiDocumentedItem class

An abstract base class for API declarations that can have an associated TSDoc comment.

Signature:
export declare class ApiDocumentedItem extends ApiItem
Extends: [ApiItem](/pages/api-extractor-model.apiitem)

Remarks

This is part of the ApiModel hierarchy of classes, which are serializable representations of API declarations.

Constructors

ConstructorModifiersDescription
(constructor)(options)Constructs a new instance of the ApiDocumentedItem class

Properties

PropertyModifiersTypeDescription
tsdocCommenttsdoc.DocComment | undefined

Methods

MethodModifiersDescription
onDeserializeInto(options, context, jsonObject)static
serializeInto(jsonObject)