Files
react-native-devtools-frontend/node_modules/@es-joy/jsdoccomment/dist/jsdoccomment.d.ts
T
Simon Zünd aebbf4f106 [deps] Update 'eslint-plugin-jsdoc' to 46.10.1
This silences a warning because our Node engine is newer then the
package expects.

There are newer versions of the plugin by now, but the transitive
dependencies are younger than 1 week so the audit mirror blocks them.
46.10.1 seems like it was stable for a couple months so we use that.

R=alexrudenko@chromium.org

Bug: None
Change-Id: Icf1c1276852e55dcad97d2ea2eeb6a8d7a9d82ae
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/5660063
Commit-Queue: Simon Zünd <szuend@chromium.org>
Auto-Submit: Simon Zünd <szuend@chromium.org>
Commit-Queue: Alex Rudenko <alexrudenko@chromium.org>
Reviewed-by: Alex Rudenko <alexrudenko@chromium.org>
2024-06-27 09:26:18 +00:00

69 lines
2.7 KiB
TypeScript

export type Token = import('eslint').AST.Token | import('estree').Comment | {
type: import('eslint').AST.TokenType | "Line" | "Block" | "Shebang";
range: [number, number];
value: string;
};
export type ESLintOrTSNode = import('eslint').Rule.Node | import('@typescript-eslint/types').TSESTree.Node;
export type int = number;
/**
* Reduces the provided node to the appropriate node for evaluating
* JSDoc comment status.
*
* @param {import('eslint').Rule.Node} node An AST node.
* @param {import('eslint').SourceCode} sourceCode The ESLint SourceCode.
* @returns {import('eslint').Rule.Node} The AST node that
* can be evaluated for appropriate JSDoc comments.
*/
export function getReducedASTNode(node: import('eslint').Rule.Node, sourceCode: import('eslint').SourceCode): import('eslint').Rule.Node;
/**
* Retrieves the JSDoc comment for a given node.
*
* @param {import('eslint').SourceCode} sourceCode The ESLint SourceCode
* @param {import('eslint').Rule.Node} node The AST node to get
* the comment for.
* @param {{maxLines: int, minLines: int, [name: string]: any}} settings The
* settings in context
* @returns {Token|null} The Block comment
* token containing the JSDoc comment for the given node or
* null if not found.
* @public
*/
export function getJSDocComment(sourceCode: import('eslint').SourceCode, node: import('eslint').Rule.Node, settings: {
[name: string]: any;
maxLines: int;
minLines: int;
}): Token | null;
/**
* @param {(import('estree').Comment|import('eslint').Rule.Node) & {
* declaration?: any,
* decorators?: any[],
* parent?: import('eslint').Rule.Node & {
* decorators?: any[]
* }
* }} node
* @returns {import('@typescript-eslint/types').TSESTree.Decorator|undefined}
*/
export function getDecorator(node: (import('estree').Comment | import('eslint').Rule.Node) & {
declaration?: any;
decorators?: any[];
parent?: import('eslint').Rule.Node & {
decorators?: any[];
};
}): import('@typescript-eslint/types').TSESTree.Decorator | undefined;
/**
* Checks for the presence of a JSDoc comment for the given node and returns it.
*
* @param {import('eslint').Rule.Node} astNode The AST node to get
* the comment for.
* @param {import('eslint').SourceCode} sourceCode
* @param {{maxLines: int, minLines: int, [name: string]: any}} settings
* @returns {Token|null} The Block comment token containing the JSDoc comment
* for the given node or null if not found.
* @private
*/
export function findJSDocComment(astNode: import('eslint').Rule.Node, sourceCode: import('eslint').SourceCode, settings: {
[name: string]: any;
maxLines: int;
minLines: int;
}): Token | null;
//# sourceMappingURL=jsdoccomment.d.ts.map