Adds TS types

* adds TypeScript types

---------

Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com>

package.json

@@ -6,6 +6,7 @@
     "name": "Athan Reines",
     "email": "kgryte@gmail.com"
   },
+  "types": "./types/index.d.ts",
   "contributors": [
     {
       "name": "Athan Reines",

types/index.d.ts

@@ -0,0 +1,27 @@
+/**
+* Accessor function.
+*
+* @param value - input value
+* @returns numerical value
+*/
+type AccessorFunction<T> = (value: T) => number;
+
+/**
+ * Computes the cosine similarity between two arrays.
+ *
+ * @param x - input array
+ * @param y - input array
+ * @param accessor - accessor function for accessing array values
+ * @returns cosine similarity or null
+ */
+declare function similarity(
+  x: number[],
+  y: number[],
+): number | null;
+declare function similarity<T>(
+  x: T[],
+  y: T[],
+  accessor: AccessorFunction<T>
+): number | null;
+
+export default similarity