Skip to main content

tsdoc-require-2/require-function

Require the @function tag in TSDoc blocks for supported TypeScript declarations.

Rule details​

This rule reports declarations that already have TSDoc but do not contain @function.

It does not create a TSDoc block. Pair it with tsdoc-require-2/require when you also want to require comments.

Why use it​

@function can help teams and doc generators that expect explicit declaration-kind tags.

Options​

This rule accepts the same options as tsdoc-require-2/require:

  • enforceFor: limit which declaration kinds are checked.
  • exportMode: choose whether to check exported declarations, non-exported top-level declarations, or both.
  • includeNonExported: legacy alias for exportMode: "all".

Flat config example (function-only scope):

import tsdocRequire from "eslint-plugin-tsdoc-require-2";

export default [
 {
  plugins: {
   "tsdoc-require-2": tsdocRequire,
  },
  rules: {
   "tsdoc-require-2/require-function": ["error", { enforceFor: ["function"] }],
  },
 },
];

❌ Incorrect​

/**
 * Creates a stable slug for a title.
 */
export function toSlug(value: string): string {
 return value.trim().toLowerCase();
}

✅ Correct​

/**
 * Creates a stable slug for a title.
 *
 * @function
 */
export function toSlug(value: string): string {
 return value.trim().toLowerCase();
}

When not to use it​

Disable this rule if your documentation convention does not require @function on the declarations targeted by your configuration.

Further reading​