From 1982431fd0b236de7580fde132fd7491e1ed5d13 Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Thu, 6 Mar 2025 18:25:45 +0100 Subject: refactor(internet): deprecate color method for removal (#3401) --- src/modules/internet/index.ts | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'src') diff --git a/src/modules/internet/index.ts b/src/modules/internet/index.ts index 3be0f292..afad6d39 100644 --- a/src/modules/internet/index.ts +++ b/src/modules/internet/index.ts @@ -817,11 +817,15 @@ export class InternetModule extends ModuleBase { * @param options.greenBase The optional base green in range between `0` and `255`. Defaults to `0`. * @param options.blueBase The optional base blue in range between `0` and `255`. Defaults to `0`. * + * @see faker.color.rgb(): For generating a random RGB color. + * * @example * faker.internet.color() // '#30686e' * faker.internet.color({ redBase: 100, greenBase: 100, blueBase: 100 }) // '#4e5f8b' * * @since 2.0.1 + * + * @deprecated Please use faker.color.rgb() or any of the other color methods instead. */ color( options: { @@ -845,6 +849,13 @@ export class InternetModule extends ModuleBase { blueBase?: number; } = {} ): string { + deprecated({ + deprecated: 'faker.internet.color()', + proposed: 'faker.color.rgb()', + since: '9.6.0', + until: '10.0.0', + }); + const { redBase = 0, greenBase = 0, blueBase = 0 } = options; const red = colorFromBase(this.faker, redBase); -- cgit v1.2.3