Home > @microsoft/api-extractor-model > ApiItemContainerMixin > tryGetMemberByKey

ApiItemContainerMixin.tryGetMemberByKey() method

Attempts to retrieve a member using its containerKey, or returns undefined if no matching member was found.

Signature:

tryGetMemberByKey(containerKey: string): ApiItem | undefined;

Parameters

Parameter Type Description
containerKey string  

Returns:

ApiItem | undefined

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.

See ApiItem.containerKey for more information.