quoridor - npm Package Compare versions

Comparing version 1.2.0 to 1.2.1

package.json

 {
   "name": "quoridor",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "A JavaScipt Quoridor library for move validation etc.",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

@@ -22,28 +22,44 @@ # quoridor.js
 
-┌───╫───╫───╫───╫───╫───╫───╫───╫───╫───╫───┐
-│   ║   ║   ║   ║   ║   ║   ║   ║   ║   ║   │
-│   ┌───┬───┬───┬───┬───┬───┬───┬───┬───┐   │
-│ 9 │   │   │   │   │   │   │   │   │   │   │
-│   ├───┼───┼───┼───┼───┼───┼───┼───┼───┤   │
-│ 8 │   │   │   │   │   │   │   │   │   │   │
-│   ├───┼───┼───┼───┼───┼───┼───┼───┼───┤   │
-│ 7 │   │   │   │   ║ 2 │   │   │   │   │   │
-│   ├───┼───┼───┼───╫───┼───┼───┼───┼───┤   │
-│ 6 │   │   │   │   ║   │   │   │   │   │   │
-│   ├───┼───┼───┼───┼───┼───┼───┼───┼───┤   │
-│ 5 │   │   │   │   │   │   │   │   │   │   │
-│   ├───┼───┼───┼───┼───┼───┼───┼───┼───┤   │
-│ 4 │   │   │   │   │   │   │   │   │   │   │
-│   ├───┼───┼───┼───┼───┼───┼───┼───┼───┤   │
-│ 3 │   │   │   │   │ 1 │   │   │   │   │   │
-│   ├───┼───┼───┼───┼───┼───┼───┼───┼───┤   │
-│ 2 │   │   │   │   │   │   │   │   │   │   │
-│   ├───┼───┼───┼───┼───┼───┼───┼───┼───┤   │
-│ 1 │   │   │   │   │   │   │   │   │   │   │
-│   └───┴───┴───┴───┴───┴───┴───┴───┴───┘   │
-│   ║ A ║ B ║ C ║ D ║ E ║ F ║ G ║ H ║ I     │
-└───╫───╫───╫───╫───╫───╫───╫───╫───╫───────┘
+// ┌───╫───╫───╫───╫───╫───╫───╫───╫───╫───╫───┐
+// │   ║   ║   ║   ║   ║   ║   ║   ║   ║   ║   │
+// │   ┌───┬───┬───┬───┬───┬───┬───┬───┬───┐   │
+// │ 9 │   │   │   │   │   │   │   │   │   │   │
+// │   ├───┼───┼───┼───┼───┼───┼───┼───┼───┤   │
+// │ 8 │   │   │   │   │   │   │   │   │   │   │
+// │   ├───┼───┼───┼───┼───┼───┼───┼───┼───┤   │
+// │ 7 │   │   │   │   ║ 2 │   │   │   │   │   │
+// │   ├───┼───┼───┼───╫───┼───┼───┼───┼───┤   │
+// │ 6 │   │   │   │   ║   │   │   │   │   │   │
+// │   ├───┼───┼───┼───┼───┼───┼───┼───┼───┤   │
+// │ 5 │   │   │   │   │   │   │   │   │   │   │
+// │   ├───┼───┼───┼───┼───┼───┼───┼───┼───┤   │
+// │ 4 │   │   │   │   │   │   │   │   │   │   │
+// │   ├───┼───┼───┼───┼───┼───┼───┼───┼───┤   │
+// │ 3 │   │   │   │   │ 1 │   │   │   │   │   │
+// │   ├───┼───┼───┼───┼───┼───┼───┼───┼───┤   │
+// │ 2 │   │   │   │   │   │   │   │   │   │   │
+// │   ├───┼───┼───┼───┼───┼───┼───┼───┼───┤   │
+// │ 1 │   │   │   │   │   │   │   │   │   │   │
+// │   └───┴───┴───┴───┴───┴───┴───┴───┴───┘   │
+// │   ║ A ║ B ║ C ║ D ║ E ║ F ║ G ║ H ║ I     │
+// └───╫───╫───╫───╫───╫───╫───╫───╫───╫───────┘
 
 ```
 
+### isValidMove: (game: Game, move: Move) => boolean
+
+Checks if a move is valid.
+
+```TypeScript
+import { createGameFromMoves, isValidMove } from 'quoridor';
+
+const game = createGameFromMoves(['e2', 'e8', 'd7v']);
+
+const moveIsValid = isValidMove(game, 'd7');
+
+console.log(moveIsValid);
+
+// false
+```
+
 ## Publishing a new version
@@ -50,0 +66,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

80667

increased by0.46%

Number of lines in readme file

86

increased by22.86%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes