1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
import { deprecated } from './internal/deprecated';
import type { RecordKey } from './utils/unique';
import * as uniqueExec from './utils/unique';
/**
* Module to generate unique entries.
*/
export class Unique {
/**
* Maximum time `unique.exec` will attempt to run before aborting.
*
* @deprecated Use options instead.
*/
private _maxTime = 10;
/**
* Maximum time `unique.exec` will attempt to run before aborting.
*
* @deprecated Use options instead.
*/
get maxTime(): number {
deprecated({
deprecated: 'faker.unique.maxTime',
proposed: 'Options',
since: 'v6.2.0',
until: 'v7.0.0',
});
return this._maxTime;
}
/**
* Maximum time `unique.exec` will attempt to run before aborting.
*
* @deprecated Use options instead.
*/
set maxTime(value: number) {
deprecated({
deprecated: 'faker.unique.maxTime',
proposed: 'Options',
since: 'v6.2.0',
until: 'v7.0.0',
});
this._maxTime = value;
}
/**
* Maximum retries `unique.exec` will recurse before aborting (max loop depth).
*
* @deprecated Use options instead.
*/
private _maxRetries = 10;
/**
* Maximum retries `unique.exec` will recurse before aborting (max loop depth).
*
* @deprecated Use options instead.
*/
get maxRetries(): number {
deprecated({
deprecated: 'faker.unique.maxRetries',
proposed: 'Options',
since: 'v6.2.0',
until: 'v7.0.0',
});
return this._maxRetries;
}
/**
* Maximum retries `unique.exec` will recurse before aborting (max loop depth).
*
* @deprecated Use options instead.
*/
set maxRetries(value: number) {
deprecated({
deprecated: 'faker.unique.maxRetries',
proposed: 'Options',
since: 'v6.2.0',
until: 'v7.0.0',
});
this._maxRetries = value;
}
constructor() {
// Bind `this` so namespaced is working correctly
for (const name of Object.getOwnPropertyNames(Unique.prototype)) {
if (
name === 'constructor' ||
name === 'maxTime' ||
name === 'maxRetries' ||
typeof this[name] !== 'function'
) {
continue;
}
this[name] = this[name].bind(this);
}
}
/**
* Generates a unique result using the results of the given method.
* Used unique entries will be stored internally and filtered from subsequent calls.
*
* @template Method The type of the method to execute.
* @param method The method used to generate the values.
* @param args The arguments used to call the method.
* @param options The optional options used to configure this method.
* @param options.startTime This parameter does nothing.
* @param options.maxTime The time in milliseconds this method may take before throwing an error. Defaults to `50`.
* @param options.maxRetries The total number of attempts to try before throwing an error. Defaults to `50`.
* @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'
*/
unique<Method extends (...parameters) => RecordKey>(
method: Method,
args?: Parameters<Method>,
options: {
startTime?: number;
maxTime?: number;
maxRetries?: number;
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;
return uniqueExec.exec(method, args, {
...options,
startTime: new Date().getTime(),
maxTime,
maxRetries,
currentIterations: 0,
});
}
}
|
