aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorShinigami <[email protected]>2022-04-10 17:44:03 +0200
committerGitHub <[email protected]>2022-04-10 17:44:03 +0200
commit301ad541154648bb8e72eb2e3d33ec5ac581e3ef (patch)
tree103da0e537de02588478416e0e3677a5069b1f3d /src
parentd544ef9266fdc4b380ab069435b73b647282b17d (diff)
downloadfaker-301ad541154648bb8e72eb2e3d33ec5ac581e3ef.tar.xz
faker-301ad541154648bb8e72eb2e3d33ec5ac581e3ef.zip
refactor: log messages for unique fields (#828)
Diffstat (limited to 'src')
-rw-r--r--src/unique.ts67
1 files changed, 64 insertions, 3 deletions
diff --git a/src/unique.ts b/src/unique.ts
index 75773571..ff8698e6 100644
--- a/src/unique.ts
+++ b/src/unique.ts
@@ -1,3 +1,4 @@
+import { deprecated } from './internal/deprecated';
import type { RecordKey } from './utils/unique';
import * as uniqueExec from './utils/unique';
@@ -10,14 +11,74 @@ export class Unique {
*
* @deprecated Use options instead.
*/
- maxTime = 10;
+ 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.
*/
- maxRetries = 10;
+ 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
@@ -59,7 +120,7 @@ export class Unique {
compare?: (obj: Record<RecordKey, RecordKey>, key: RecordKey) => 0 | -1;
} = {}
): ReturnType<Method> {
- const { maxTime = this.maxTime, maxRetries = this.maxRetries } = options;
+ const { maxTime = this._maxTime, maxRetries = this._maxRetries } = options;
return uniqueExec.exec(method, args, {
...options,
startTime: new Date().getTime(),