feat: add method overloads

For better type information
octokit · Feb 23, 2024 · ee6147d · ee6147d
1 parent e164054
commit ee6147d
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/src/node/sign.ts b/src/node/sign.ts
@@ -2,6 +2,8 @@ import { createHmac } from "node:crypto";
 import { Algorithm, type SignOptions } from "../types.js";
 import { VERSION } from "../version.js";
 
+export async function sign(secret: string, payload: string): Promise<string>;
+export async function sign(options: SignOptions, payload: string): Promise<string>;
 export async function sign(
  options: SignOptions | string,
  payload: string,

diff --git a/src/web.ts b/src/web.ts
@@ -45,6 +45,8 @@ async function importKey(secret: string, algorithm: AlgorithmLike) {
  );
 }
 
+export async function sign(secret: string, payload: string): Promise<string>;
+export async function sign(options: SignOptions, payload: string): Promise<string>;
 export async function sign(options: SignOptions | string, payload: string) {
  const { secret, algorithm } =
  typeof options === "object"