mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-11 17:13:31 +01:00
5c0fad3b2d
* fix(ExceptText): don't display import("d..-types/v10"). in return type
* Squashed 'packages/api-extractor-model/' content from commit 39ecb196c
git-subtree-dir: packages/api-extractor-model
git-subtree-split: 39ecb196ca210bdf84ba6c9cadb1bb93571849d7
* Squashed 'packages/api-extractor/' content from commit 341ad6c51
git-subtree-dir: packages/api-extractor
git-subtree-split: 341ad6c51b01656d4f73b74ad4bdb3095f9262c4
* feat(api-extractor): add api-extractor and -model
* fix: package.json docs script
* fix(SourcLink): use <> instead of function syntax
* fix: make packages private
* fix: rest params showing in docs, added labels
* fix: missed two files
* fix: cpy-cli & pnpm-lock
* fix: increase icon size
* fix: icon size again
74 lines
1.8 KiB
TypeScript
74 lines
1.8 KiB
TypeScript
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
|
|
// See LICENSE in the project root for license information.
|
|
|
|
import type { ApiItem } from '../items/ApiItem.js';
|
|
|
|
/**
|
|
* Generic result object for finding API items used by different kinds of find operations.
|
|
*
|
|
* @public
|
|
*/
|
|
export interface IFindApiItemsResult {
|
|
/**
|
|
* The API items that were found. Not guaranteed to be complete, see `maybeIncompleteResult`.
|
|
*/
|
|
items: ApiItem[];
|
|
|
|
/**
|
|
* Indicates whether the result is potentially incomplete due to errors during the find operation.
|
|
* If true, the `messages` explain the errors in more detail.
|
|
*/
|
|
maybeIncompleteResult: boolean;
|
|
|
|
/**
|
|
* Diagnostic messages regarding the find operation.
|
|
*/
|
|
messages: IFindApiItemsMessage[];
|
|
}
|
|
|
|
/**
|
|
* This object is used for messages returned as part of `IFindApiItemsResult`.
|
|
*
|
|
* @public
|
|
*/
|
|
export interface IFindApiItemsMessage {
|
|
/**
|
|
* Unique identifier for the message.
|
|
*
|
|
* @beta
|
|
*/
|
|
messageId: FindApiItemsMessageId;
|
|
|
|
/**
|
|
* Text description of the message.
|
|
*/
|
|
text: string;
|
|
}
|
|
|
|
/**
|
|
* Unique identifiers for messages returned as part of `IFindApiItemsResult`.
|
|
*
|
|
* @public
|
|
*/
|
|
export enum FindApiItemsMessageId {
|
|
/**
|
|
* "Unable to resolve declaration reference within API item ___: ___"
|
|
*/
|
|
DeclarationResolutionFailed = 'declaration-resolution-failed',
|
|
|
|
/**
|
|
* "Unable to analyze extends clause ___ of API item ___ because no canonical reference was found."
|
|
*/
|
|
ExtendsClauseMissingReference = 'extends-clause-missing-reference',
|
|
|
|
/**
|
|
* "Unable to analyze references of API item ___ because it is not associated with an ApiModel"
|
|
*/
|
|
NoAssociatedApiModel = 'no-associated-api-model',
|
|
|
|
/**
|
|
* "Unable to analyze references of API item ___ because it is of unsupported kind ___"
|
|
*/
|
|
UnsupportedKind = 'unsupported-kind',
|
|
}
|