cafe-utility 10.16.0 → 10.18.0

package/index.d.ts

@@ -22,6 +22,10 @@ declare function chance(threshold: number, generator?: () => number): boolean;
 declare function pick<T>(array: T[], generator?: () => number): T;
 declare function pickMany<T>(array: T[], count: number, generator?: () => number): T[];
 declare function pickManyUnique<T>(array: T[], count: number, equalityFunction: (a: T, b: T) => boolean, generator?: () => number): T[];
+declare function pickGuaranteed<T>(array: T[], include: T | null, exclude: T | null, count: number, predicate: (value: T, values: T[]) => boolean, generator?: () => number): {
+    values: T[];
+    indexOfGuaranteed: number;
+};
 declare function last<T>(array: T[]): T;
 declare function pickWeighted<T>(array: T[], weights: number[], randomNumber?: number): T;
 declare function sortWeighted<T>(array: T[], weights: number[], generator?: () => number): T[];
@@ -387,6 +391,7 @@ export declare const Arrays: {
     pickManyUnique: typeof pickManyUnique;
     pickWeighted: typeof pickWeighted;
     pickRandomIndices: typeof pickRandomIndices;
+    pickGuaranteed: typeof pickGuaranteed;
     last: typeof last;
     sortWeighted: typeof sortWeighted;
     pushAll: typeof pushAll;

package/index.js

@@ -169,6 +169,23 @@ function pickManyUnique(array, count, equalityFunction, generator = Math.random)
     return results
 }
 
+function pickGuaranteed(array, include, exclude, count, predicate, generator = Math.random) {
+    const choices = array.filter(x => x !== include && x !== exclude)
+    const picks = []
+    if (include !== null) {
+        picks.push(include)
+    }
+    while (choices.length && picks.length < count) {
+        const index = exports.Random.intBetween(0, choices.length - 1, generator)
+        if (predicate(choices[index], picks)) {
+            picks.push(choices[index])
+        }
+        choices.splice(index, 1)
+    }
+    shuffle(picks, generator)
+    return { values: picks, indexOfGuaranteed: include !== null ? picks.indexOf(include) : -1 }
+}
+
 function last(array) {
     return array[array.length - 1]
 }
@@ -2631,6 +2648,7 @@ exports.Arrays = {
     pickManyUnique,
     pickWeighted,
     pickRandomIndices,
+    pickGuaranteed,
     last,
     sortWeighted,
     pushAll,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "cafe-utility",
-    "version": "10.16.0",
+    "version": "10.18.0",
     "description": "",
     "main": "index.js",
     "exports": {