chore: use a standardized deprecated function (#689)

Co-authored-by: pkuczynski <[email protected]>

1 files changed, 29 insertions, 0 deletions

diff --git a/src/internal/deprecated.ts b/src/internal/deprecated.ts
new file mode 100644
index 00000000..7f20c24f
--- /dev/null
+++ b/src/internal/deprecated.ts
@@ -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 + '.');
+}