Skip to content

script-utils/linters/eslint-rules/require-method-template

ESLint rule: require-method-template

Requires that generic methods (methods with type parameters) have corresponding @typeParam (or @template) JSDoc tags for each type parameter.

This fills a gap in eslint-plugin-jsdoc’s require-template rule, which only checks top-level declarations (functions, classes, interfaces, type aliases) but not methods within classes.

@see https://github.com/gajus/eslint-plugin-jsdoc/issues/1386

VariableDescription
MESSAGE_ID_MISSING_TEMPLATEMessage ID reported when a method type parameter has no matching @typeParam tag.
MESSAGE_ID_MISSING_TEMPLATE_DESCRIPTIONMessage ID reported when a method’s @typeParam tag is missing a description.
requireMethodTemplate