utils/node_modules/@microsoft/api-extractor-model/lib/mixins/IFindApiItemsResult.js.map

{"version":3,"file":"IFindApiItemsResult.js","sourceRoot":"","sources":["../../src/mixins/IFindApiItemsResult.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AA2C3D;;;GAGG;AACH,IAAY,qBAoBX;AApBD,WAAY,qBAAqB;IAC/B;;OAEG;IACH,sFAA6D,CAAA;IAE7D;;OAEG;IACH,2FAAkE,CAAA;IAElE;;OAEG;IACH,yEAAgD,CAAA;IAEhD;;OAEG;IACH,6DAAoC,CAAA;AACtC,CAAC,EApBW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAoBhC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport type { ApiItem } from '../items/ApiItem';\n\n/**\n * Generic result object for finding API items used by different kinds of find operations.\n * @public\n */\nexport interface IFindApiItemsResult {\n  /**\n   * The API items that were found. Not guaranteed to be complete, see `maybeIncompleteResult`.\n   */\n  items: ApiItem[];\n\n  /**\n   * Diagnostic messages regarding the find operation.\n   */\n  messages: IFindApiItemsMessage[];\n\n  /**\n   * Indicates whether the result is potentially incomplete due to errors during the find operation.\n   * If true, the `messages` explain the errors in more detail.\n   */\n  maybeIncompleteResult: boolean;\n}\n\n/**\n * This object is used for messages returned as part of `IFindApiItemsResult`.\n * @public\n */\nexport interface IFindApiItemsMessage {\n  /**\n   * Unique identifier for the message.\n   * @beta\n   */\n  messageId: FindApiItemsMessageId;\n\n  /**\n   * Text description of the message.\n   */\n  text: string;\n}\n\n/**\n * Unique identifiers for messages returned as part of `IFindApiItemsResult`.\n * @public\n */\nexport enum FindApiItemsMessageId {\n  /**\n   * \"Unable to resolve declaration reference within API item ___: ___\"\n   */\n  DeclarationResolutionFailed = 'declaration-resolution-failed',\n\n  /**\n   * \"Unable to analyze extends clause ___ of API item ___ because no canonical reference was found.\"\n   */\n  ExtendsClauseMissingReference = 'extends-clause-missing-reference',\n\n  /**\n   * \"Unable to analyze references of API item ___ because it is not associated with an ApiModel\"\n   */\n  NoAssociatedApiModel = 'no-associated-api-model',\n\n  /**\n   * \"Unable to analyze references of API item ___ because it is of unsupported kind ___\"\n   */\n  UnsupportedKind = 'unsupported-kind'\n}\n"]}