Skip to main content

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

ApiItem.containerKey property

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.

Signature:
/** @virtual */
get containerKey(): string;

Remarks

Use the getContainerKey() static member to construct the key. Each subclass has a different implementation of this function, according to the aspects that are important for identifying it.