Merge pull request #41 from torjusti/feat/type-defs

feat: Add TypeScript definitions file

index.d.ts

@@ -0,0 +1,10 @@
+type Scrambler = '3x3' | '2gll' | 'cmll' | 'corners' | 'edges' | 'lse' | 'lsll' | 'pll' | 'zbll' | 'zzls';
+
+type Solver = 'kociemba' | 'cross' | 'eoline' | 'fb' | 'xcross';
+
+declare module 'cube-solver' {
+  // Main method for generating scrambls.
+  export const scramble: (scrambler: Scrambler) => string;
+  // Solve specific subset of a given cube.
+  export const solve: (scramble: string, type: Solver) => string;
+};

package.json

@@ -1,15 +1,17 @@
 {
   "name": "cube-solver",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Solve Rubik's cube using the Kociemba algorithm.",
   "author": "Torjus Iveland <torjusti@gmail.com>",
   "main": "dist/bundle.js",
+  "types": "index.d.ts",
   "repository": {
     "type": "git",
     "url": "https://github.com/torjusti/cube-solver"
   },
   "files": [
-    "dist"
+    "dist",
+    "index.d.ts"
   ],
   "bugs": {
     "url": "https://github.com/torjusti/cube-solver/issues"