@gamepark/rules-api 6.24.2 → 6.24.3

package/dist/utils/random.util.d.ts

@@ -1,4 +1,15 @@
 import { RandomMove } from '../RandomMove';
 import { Rules } from '../Rules';
+/**
+ * Type guard for rules with Random moves
+ * @param rules The game's rules
+ * @return true if the rules implements {@link RandomMove} interface
+ */
 export declare function hasRandomMove<Game, Move, RandomizedMove>(rules: Rules<Game, Move>): rules is Rules<Game, Move> & RandomMove<Move, RandomizedMove>;
+/**
+ * Randomizes a list of moves at once
+ * @param rules Rules of the game
+ * @param moves Moves to randomize
+ * @returns the randomized moves if the rules implements {@link RandomMove}
+ */
 export declare function randomizeMoves<Game, Move, RandomizedMove = Move>(rules: Rules<Game, Move>, moves: Move[]): (Move & RandomizedMove)[];

package/dist/utils/random.util.js

@@ -1,11 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.randomizeMoves = exports.hasRandomMove = void 0;
+/**
+ * Type guard for rules with Random moves
+ * @param rules The game's rules
+ * @return true if the rules implements {@link RandomMove} interface
+ */
 function hasRandomMove(rules) {
     var test = rules;
     return typeof test.randomize === 'function';
 }
 exports.hasRandomMove = hasRandomMove;
+/**
+ * Randomizes a list of moves at once
+ * @param rules Rules of the game
+ * @param moves Moves to randomize
+ * @returns the randomized moves if the rules implements {@link RandomMove}
+ */
 function randomizeMoves(rules, moves) {
     if (hasRandomMove(rules)) {
         return moves.map(function (move) { return rules.randomize(move); });

package/dist/utils/random.util.js.map

@@ -1 +1 @@
-{"version":3,"file":"random.util.js","sourceRoot":"","sources":["../../src/utils/random.util.ts"],"names":[],"mappings":";;;AAQA,SAAgB,aAAa,CAC3B,KAAwB;IAExB,IAAM,IAAI,GAAG,KAA6D,CAAA;IAC1E,OAAO,OAAO,IAAI,CAAC,SAAS,KAAK,UAAU,CAAA;AAC7C,CAAC;AALD,sCAKC;AAQD,SAAgB,cAAc,CAAoC,KAAwB,EAAE,KAAa;IACvG,IAAI,aAAa,CAA6B,KAAK,CAAC,EAAE,CAAC;QACrD,OAAO,KAAK,CAAC,GAAG,CAAC,UAAA,IAAI,IAAI,OAAA,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,EAArB,CAAqB,CAAC,CAAA;IACjD,CAAC;SAAM,CAAC;QACN,OAAO,KAAkC,CAAA;IAC3C,CAAC;AACH,CAAC;AAND,wCAMC"}
+{"version":3,"file":"random.util.js","sourceRoot":"","sources":["../../src/utils/random.util.ts"],"names":[],"mappings":";;;AAGA;;;;GAIG;AACH,SAAgB,aAAa,CAC3B,KAAwB;IAExB,IAAM,IAAI,GAAG,KAA6D,CAAA;IAC1E,OAAO,OAAO,IAAI,CAAC,SAAS,KAAK,UAAU,CAAA;AAC7C,CAAC;AALD,sCAKC;AAED;;;;;GAKG;AACH,SAAgB,cAAc,CAAoC,KAAwB,EAAE,KAAa;IACvG,IAAI,aAAa,CAA6B,KAAK,CAAC,EAAE,CAAC;QACrD,OAAO,KAAK,CAAC,GAAG,CAAC,UAAA,IAAI,IAAI,OAAA,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,EAArB,CAAqB,CAAC,CAAA;IACjD,CAAC;SAAM,CAAC;QACN,OAAO,KAAkC,CAAA;IAC3C,CAAC;AACH,CAAC;AAND,wCAMC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gamepark/rules-api",
-  "version": "6.24.2",
+  "version": "6.24.3",
   "description": "API to implement the rules of a board game",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",