feat: add TypeScript declarations

Closes #122
kenany · Mar 26, 2023 · ef22831 · ef22831
1 parent 398a873
commit ef22831
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -0,0 +1,20 @@
+declare module 'glicko2-lite' {
+  export = (
+    rating: number,
+    rd: number,
+    vol: number,
+    opponents: [
+      number, // rating
+      number, // rd
+      number // score 0..1
+    ][],
+    options?: {
+      rating?: number,
+      tau?: number
+    }
+  ) => ({
+    rating: number,
+    rd: number,
+    vol: number
+  });
+}
diff --git a/package.json b/package.json
@@ -9,6 +9,7 @@
   "license": "MIT",
   "author": "Kenan Yildirim <kenan@kenany.me> (https://kenany.me/)",
   "main": "index.js",
+  "type": "index.d.ts",
   "engines": {
     "node": "14 || 16 || >=18"
   },