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

Remarks

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

Constructors

Constructor	Modifiers	Description
(constructor)(options)		Constructs a new instance of the ApiDocumentedItem class

Properties

Property	Modifiers	Type	Description
tsdocComment	readonly	tsdoc.DocComment | undefined

Methods

Method	Modifiers	Description
onDeserializeInto(options, context, jsonObject)	static
serializeInto(jsonObject)