⬅️ Back to Table of Contents

📄 hasOverloadSignatures

📊 Analysis Summary

Metric	Count
🔧 Functions	2
📦 Imports	4

📚 Table of Contents

• Imports
• Functions

🛠️ File Location:

📂 packages/eslint-plugin/src/util/hasOverloadSignatures.ts

📦 Imports

Name	Source
TSESTree	@typescript-eslint/utils
RuleContext	@typescript-eslint/utils/ts-eslint
AST_NODE_TYPES	@typescript-eslint/utils
getStaticMemberAccessValue	./misc

---

Functions

hasOverloadSignatures(node: TSESTree.FunctionDeclaration | TSESTree…, context: RuleContext<string, unknown[]>): boolean

Returns: undefined true if the function or method node has overload signatures.

Raw JSDoc

/**
 * @return `true` if the function or method node has overload signatures.
 */

Calls:

• node.parent.parent.body.some
• getFunctionDeclarationName
• node.parent.body.some

Internal Comments:

// `export default function () {}`
// `export function f() {}`
// either: (x2)
// - `function f() {}` (x2)
// - `class T { foo() {} }` (x2)

Code

export function hasOverloadSignatures(
  node: TSESTree.FunctionDeclaration | TSESTree.MethodDefinition,
  context: RuleContext<string, unknown[]>,
): boolean {
  // `export default function () {}`
  if (node.parent.type === AST_NODE_TYPES.ExportDefaultDeclaration) {
    return node.parent.parent.body.some(member => {
      return (
        member.type === AST_NODE_TYPES.ExportDefaultDeclaration &&
        member.declaration.type === AST_NODE_TYPES.TSDeclareFunction
      );
    });
  }

  // `export function f() {}`
  if (node.parent.type === AST_NODE_TYPES.ExportNamedDeclaration) {
    return node.parent.parent.body.some(member => {
      return (
        member.type === AST_NODE_TYPES.ExportNamedDeclaration &&
        member.declaration?.type === AST_NODE_TYPES.TSDeclareFunction &&
        getFunctionDeclarationName(member.declaration, context) ===
          getFunctionDeclarationName(node, context)
      );
    });
  }

  // either:
  // - `function f() {}`
  // - `class T { foo() {} }`

  const nodeKey = getFunctionDeclarationName(node, context);

  return node.parent.body.some(member => {
    return (
      (member.type === AST_NODE_TYPES.TSDeclareFunction ||
        (member.type === AST_NODE_TYPES.MethodDefinition &&
          member.value.body == null)) &&
      nodeKey === getFunctionDeclarationName(member, context)
    );
  });
}

getFunctionDeclarationName(node: | TSESTree.FunctionDeclaration | TSESTr…, context: RuleContext<string, unknown[]>): string | symbol | undefined

Parameters:

• node | TSESTree.FunctionDeclaration | TSESTree.MethodDefinition | TSESTree.TSDeclareFunction
• context RuleContext<string, unknown[]>

Returns: string | symbol | undefined

Calls:

• getStaticMemberAccessValue (from ./misc)

Internal Comments:

// For a `FunctionDeclaration` or `TSDeclareFunction` this may be `null` if
// and only if the parent is an `ExportDefaultDeclaration`.
//
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion

Code

function getFunctionDeclarationName(
  node:
    | TSESTree.FunctionDeclaration
    | TSESTree.MethodDefinition
    | TSESTree.TSDeclareFunction,
  context: RuleContext<string, unknown[]>,
): string | symbol | undefined {
  if (
    node.type === AST_NODE_TYPES.FunctionDeclaration ||
    node.type === AST_NODE_TYPES.TSDeclareFunction
  ) {
    // For a `FunctionDeclaration` or `TSDeclareFunction` this may be `null` if
    // and only if the parent is an `ExportDefaultDeclaration`.
    //
    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
    return node.id!.name;
  }

  return getStaticMemberAccessValue(node, context);
}

---

Generated by Syntax Scribe