Home > @microsoft/api-extractor-model > ApiItem
ApiItem class
The abstract base class for all members of an ApiModel object.
Signature:
export declare class 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 ApiItem class |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| canonicalReference | readonly | DeclarationReference | (BETA) Warning: This API is used internally by API extractor but is not yet ready for general usage. |
| containerKey | readonly | string | Returns a string key that can be used to efficiently retrieve an ApiItem from an ApiItemContainerMixin. The key is unique within the container. Its format is undocumented and may change at any time. |
| displayName | readonly | string | Returns a name for this object that can be used in diagnostic messages, for example. |
| kind | readonly | ApiItemKind | Identifies the subclass of the ApiItem base class. |
| members | readonly | ReadonlyArray<ApiItem> | This property supports a visitor pattern for walking the tree. For items with ApiItemContainerMixin, it returns the contained items, sorted alphabetically. Otherwise it returns an empty array. |
| parent | readonly | ApiItem | undefined | If this item was added to a ApiItemContainerMixin item, then this returns the container item. If this is an Parameter that was added to a method or function, then this returns the function item. Otherwise, it returns undefined. |
Methods
| Method | Modifiers | Description |
|---|---|---|
| buildCanonicalReference() | protected | Builds the cached object used by the canonicalReference property. |
| deserialize(jsonObject, context) | static | |
| getAssociatedModel() | If this item is an ApiModel or has an ApiModel as one of its parents, then that object is returned. Otherwise undefined is returned. | |
| getAssociatedPackage() | If this item is an ApiPackage or has an ApiPackage as one of its parents, then that object is returned. Otherwise undefined is returned. | |
| getHierarchy() | Returns the chain of ancestors, starting from the root of the tree, and ending with the this item. | |
| getMergedSiblings() | If this item has a name (i.e. extends ApiNameMixin), then return all items that have the same parent and the same name. Otherwise, return all items that have the same parent and the same ApiItemKind. | |
| getScopedNameWithinPackage() | This returns a scoped name such as "Namespace1.Namespace2.MyClass.myMember()". It does not include the package name or entry point. | |
| getSortKey() | A text string whose value determines the sort order that is automatically applied by the ApiItemContainerMixin class. | |
| onDeserializeInto(options, context, jsonObject) | static | |
| serializeInto(jsonObject) |