Skip to content

jsdoc/require-returns-check: False positive for overloads #907

@iliubinskii

Description

@iliubinskii

Sample:

  /**
   * Description.
   *
   * @returns Result.
   */
  function f(): string;

  function f(): string {
    return "Result";
  }

Expected behavior

No warnings.

Actual behavior

Getting warning:
JSDoc @returns declaration present but return expression not available in function

If this plugin is not using typescript then at least it might ignore overloads with additional option.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions