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

ApiItem.displayName property

Returns a name for this object that can be used in diagnostic messages, for example.

Signature:

/** @virtual */
readonly displayName: string;

Remarks

For an object that inherits ApiNameMixin, this will return the declared name (e.g. the name of a TypeScript function). Otherwise, it will return a string such as “(call signature)” or “(model)”.