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

ApiItem.getSortKey() method

A text string whose value determines the sort order that is automatically applied by the ApiItemContainerMixin class.

Signature:

/** @virtual */
getSortKey(): string;

Returns:

string

Remarks

The value of this string is undocumented and may change at any time. If ApiItemContainerMixin.preserveMemberOrder is enabled for the ApiItem's parent, then no sorting is performed, and this key is not used.