Method extractMethodDefinition

scripts/docs/lib/source.ts:287–315

* Extracts the method definition from a method declaration.

(
    member: ts.MethodDeclaration,
  )

   * Extracts the method definition from a method declaration.
   */
  private extractMethodDefinition(
    member: ts.MethodDeclaration,
  ): MethodDefinition {
    const functionComments = Comments.getTsDocCommentsForFunction(
      member,
      this.sourceFile,
    );
    const name = ts.isConstructorDeclaration(member)
      ? "constructor"
      : member.name.getText();
    let signature =
      name +
      "(" +
      member.parameters.map((param) => param.getText()).join(", ") +
      ")";
    signature = signature.replace(/</g, "&lt;").replace(/>/g, "&gt;");
    return {
      signature,
      comment: functionComments.comment,
      parameters: member.parameters.map((param) => {
        return {
          name: param.name.getText(),
          type: param.type?.getText() || "unknown",
          required: !param.questionToken,
          comment: functionComments.params[param.name.getText()] || "",
        };
      }),
    };
  }

  /**
   * Get the constructor definition of a class.