diff options
Diffstat (limited to 'src/modules')
| -rw-r--r-- | src/modules/location/index.ts | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/src/modules/location/index.ts b/src/modules/location/index.ts index 1d0bd4a4..76b3e100 100644 --- a/src/modules/location/index.ts +++ b/src/modules/location/index.ts @@ -199,12 +199,22 @@ export class LocationModule { /** * Returns a random localized street name. * + * @see faker.location.street() + * * @example * fakerDE.location.streetName() // 'Cavill Avenue' * * @since 8.0.0 + * + * @deprecated Use `faker.location.street()` instead. */ streetName(): string { + deprecated({ + deprecated: 'faker.location.streetName', + proposed: 'faker.location.street', + since: '8.0', + until: '9.0', + }); return this.faker.helpers.arrayElement( this.faker.definitions.location.street_name ); |
