JSPM

scramble-parser

0.1.2
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 3
  • Score
    100M100P100Q30794F
  • License MIT

Parse Rubik's cube scrambles

Package Exports

  • scramble-parser

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (scramble-parser) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

scramble-parser npm

npm install scramble-parser

API

parseScramble

Takes a given string and parses it into a scramble of Move objects.

Parameters

  • scrambleString string The string to be parsed as a scramble.

Examples

import parseScramble from 'scramble-parser';
parse("R' U F D2");
// [ { face: 'R', inverted: true, double: false },
// { face: 'U', inverted: false, double: false },
// { face: 'F', inverted: false, double: false },
// { face: 'D', inverted: false, double: true } ]

parse("R J Q D2 F U'"); // null

Returns (Array<Move> | null) An array of Move objects representing the given scramble, or null if the scramble isn't valid.