aboutsummaryrefslogtreecommitdiff
path: root/src/unique.ts
diff options
context:
space:
mode:
authorShinigami <[email protected]>2022-04-22 14:45:35 +0200
committerGitHub <[email protected]>2022-04-22 12:45:35 +0000
commit29bba7be530d2e11c56de021fc67a9641b2e6e0d (patch)
treeb6ac672ff4665bc43fbef44bd28949ec58280aa6 /src/unique.ts
parenta9048f8642bc045bb1e24abed7d54327f14981b7 (diff)
downloadfaker-29bba7be530d2e11c56de021fc67a9641b2e6e0d.tar.xz
faker-29bba7be530d2e11c56de021fc67a9641b2e6e0d.zip
feat: resettable unique store (#800)
Diffstat (limited to 'src/unique.ts')
-rw-r--r--src/unique.ts2
1 files changed, 2 insertions, 0 deletions
diff --git a/src/unique.ts b/src/unique.ts
index f59a8ef2..188a2e63 100644
--- a/src/unique.ts
+++ b/src/unique.ts
@@ -109,6 +109,7 @@ export class Unique {
* @param options.currentIterations This parameter does nothing.
* @param options.exclude The value or values that should be excluded/skipped. Defaults to `[]`.
* @param options.compare The function used to determine whether a value was already returned. Defaults to check the existence of the key.
+ * @param options.store The store of unique entries. Defaults to a global store.
*
* @example
* faker.unique(faker.name.firstName) // 'Corbin'
@@ -123,6 +124,7 @@ export class Unique {
currentIterations?: number;
exclude?: RecordKey | RecordKey[];
compare?: (obj: Record<RecordKey, RecordKey>, key: RecordKey) => 0 | -1;
+ store?: Record<RecordKey, RecordKey>;
} = {}
): ReturnType<Method> {
const { maxTime = this._maxTime, maxRetries = this._maxRetries } = options;