-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #41 from torjusti/feat/type-defs
feat: Add TypeScript definitions file
- Loading branch information
Showing
2 changed files
with
14 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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; | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters