{"gitdown": "contents", "rootId": "no-types"}
This rule reports types being used on @param
or @returns
.
The rule is intended to prevent the indication of types on tags where the type information would be redundant with TypeScript.
(TODO)
Set this to an array of strings representing the AST context (or an object with
context
and comment
properties) where you wish the rule to be applied.
Overrides the default contexts (see below). Set to "any"
if you want
the rule to apply to any jsdoc block throughout your files (as is necessary
for finding function blocks not attached to a function declaration or
expression, i.e., @callback
or @function
(or its aliases @func
or
@method
) (including those associated with an @interface
).
See the "AST and Selectors" section of our README for more on the expected format.
Context | ArrowFunctionExpression , FunctionDeclaration , FunctionExpression ; others when contexts option enabled |
Tags | param , returns |
Aliases | arg , argument , return |
Recommended | false |
Options | contexts |