Skip to content

require-param not working on angular component class methods #1166

@Taragryen

Description

@Taragryen

Expected behavior

Report an error: Missing JSDoc @param "btnState" declaration.

Actual behavior

No error reported

ESLint Config

"jsdoc/require-param": [
  "error",
  {
    "contexts": [
      "FunctionDeclaration",
      "TSFunctionType",
    ]
  }
], //not working on class methods

ESLint sample

this is an angular component class method
  /**
   * openConfirmModal
   * @memberof CreateEditTestWizardComponent
   */
  public openConfirmModal(btnState: string) {
    this.modalBtnState = btnState;
    this.openModal();
  }

Environment

  • Node version: v20.6.1
  • ESLint version: v8.42.0
  • eslint-plugin-jsdoc version: latest

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions