Home > @microsoft/api-extractor-model > IFindApiItemsResult
IFindApiItemsResult interface
Generic result object for finding API items used by different kinds of find operations.
Signature:
export interface IFindApiItemsResult
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| items | ApiItem[] | The API items that were found. Not guaranteed to be complete, see maybeIncompleteResult. | |
| maybeIncompleteResult | boolean | Indicates whether the result is potentially incomplete due to errors during the find operation. If true, the messages explain the errors in more detail. | |
| messages | IFindApiItemsMessage[] | Diagnostic messages regarding the find operation. |