-
-
Notifications
You must be signed in to change notification settings - Fork 909
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: use a standardized deprecated function (#689)
Co-authored-by: pkuczynski <piotr.kuczynski@gmail.com>
- Loading branch information
1 parent
94c96ba
commit 8ab5eff
Showing
10 changed files
with
170 additions
and
96 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
/* eslint-disable jsdoc/check-tag-names */ | ||
/* eslint-disable jsdoc/require-param */ | ||
|
||
/** @internal */ | ||
export interface DeprecatedOptions { | ||
deprecated: string; | ||
proposed?: string; | ||
since?: string; | ||
until?: string; | ||
} | ||
|
||
/** @internal */ | ||
export function deprecated(opts: DeprecatedOptions): void { | ||
let message = `[@faker-js/faker]: ${opts.deprecated} is deprecated`; | ||
|
||
if (opts.since) { | ||
message += ` since ${opts.since}`; | ||
} | ||
|
||
if (opts.until) { | ||
message += ` and will be removed in ${opts.until}`; | ||
} | ||
|
||
if (opts.proposed) { | ||
message += `. Please use ${opts.proposed} instead`; | ||
} | ||
|
||
console.warn(message + '.'); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.