aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShinigami <[email protected]>2024-03-16 08:45:16 +0100
committerGitHub <[email protected]>2024-03-16 08:45:16 +0100
commit2ec602ba1be4e04f261a96717a3d3c90a15a4c01 (patch)
treedcbdb14409f839848899d06f4fc406633671d99a
parent39648f2b3a9a192bb8644d8cdef0a35ea43c1948 (diff)
downloadfaker-2ec602ba1be4e04f261a96717a3d3c90a15a4c01.tar.xz
faker-2ec602ba1be4e04f261a96717a3d3c90a15a4c01.zip
refactor!: remove v8 deprecated type aliases (#2754)
-rw-r--r--docs/guide/upgrading_v9/2754.md31
-rw-r--r--src/index.ts60
-rw-r--r--src/locales/base/system/mimeTypes.ts4
3 files changed, 35 insertions, 60 deletions
diff --git a/docs/guide/upgrading_v9/2754.md b/docs/guide/upgrading_v9/2754.md
new file mode 100644
index 00000000..71d0bae3
--- /dev/null
+++ b/docs/guide/upgrading_v9/2754.md
@@ -0,0 +1,31 @@
+### Remove deprecated type aliases
+
+Removed deprecated type aliases
+
+| old | replacement |
+| -------------------------------- | ------------------------------- |
+| `AddressDefinitions` | `LocationDefinition` |
+| `AirlineDefinitions` | `AirlineDefinition` |
+| `AnimalDefinitions` | `AnimalDefinition` |
+| `ColorDefinitions` | `ColorDefinition` |
+| `CommerceDefinitions` | `CommerceDefinition` |
+| `CommerceProductNameDefinitions` | `CommerceProductNameDefinition` |
+| `CompanyDefinitions` | `CompanyDefinition` |
+| `DatabaseDefinitions` | `DatabaseDefinition` |
+| `DateDefinitions` | `DateDefinition` |
+| `FinanceDefinitions` | `FinanceDefinition` |
+| `HackerDefinitions` | `HackerDefinition` |
+| `InternetDefinitions` | `InternetDefinition` |
+| `LoremDefinitions` | `LoremDefinition` |
+| `MusicDefinitions` | `MusicDefinition` |
+| `NameDefinitions` | `PersonDefinition` |
+| `PhoneNumberDefinitions` | `PhoneNumberDefinition` |
+| `ScienceDefinitions` | `ScienceDefinition` |
+| `SystemDefinitions` | `SystemDefinition` |
+| `SystemMimeTypeEntryDefinitions` | `SystemMimeTypeEntryDefinition` |
+| `VehicleDefinitions` | `VehicleDefinition` |
+| `WordDefinitions` | `WordDefinition` |
+| `CSSFunction` | `CssFunctionType` |
+| `CSSSpace` | `CssSpaceType` |
+| `AddressModule` | `LocationModule` |
+| `NameModule` | `PersonModule` |
diff --git a/src/index.ts b/src/index.ts
index 33ec9e2e..82310813 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -1,73 +1,30 @@
-// organize-imports-ignore
export type {
- /** @deprecated Use LocationDefinitions instead */
- LocationDefinition as AddressDefinitions,
AirlineDefinition,
- /** @deprecated Use AirlineDefinition instead */
- AirlineDefinition as AirlineDefinitions,
AnimalDefinition,
- /** @deprecated Use AnimalDefinition instead */
- AnimalDefinition as AnimalDefinitions,
ColorDefinition,
- /** @deprecated Use ColorDefinition instead */
- ColorDefinition as ColorDefinitions,
CommerceDefinition,
- /** @deprecated Use CommerceDefinition instead */
- CommerceDefinition as CommerceDefinitions,
CommerceProductNameDefinition,
- /** @deprecated Use CommerceProductNameDefinition instead */
- CommerceProductNameDefinition as CommerceProductNameDefinitions,
CompanyDefinition,
- /** @deprecated Use CompanyDefinition instead */
- CompanyDefinition as CompanyDefinitions,
DatabaseDefinition,
- /** @deprecated Use DatabaseDefinition instead */
- DatabaseDefinition as DatabaseDefinitions,
DateDefinition,
- /** @deprecated Use DateDefinition instead */
- DateDefinition as DateDefinitions,
DateEntryDefinition,
FinanceDefinition,
- /** @deprecated Use FinanceDefinition instead */
- FinanceDefinition as FinanceDefinitions,
FoodDefinition,
HackerDefinition,
- /** @deprecated Use HackerDefinition instead */
- HackerDefinition as HackerDefinitions,
InternetDefinition,
- /** @deprecated Use InternetDefinition instead */
- InternetDefinition as InternetDefinitions,
LocaleDefinition,
LocaleEntry,
LocationDefinition,
LoremDefinition,
- /** @deprecated Use LoremDefinition instead */
- LoremDefinition as LoremDefinitions,
MetadataDefinition,
MusicDefinition,
- /** @deprecated Use MusicDefinition instead */
- MusicDefinition as MusicDefinitions,
- /** @deprecated Use PersonDefinitions instead */
- PersonDefinition as NameDefinitions,
PersonDefinition,
PhoneNumberDefinition,
- /** @deprecated Use PhoneNumberDefinition instead */
- PhoneNumberDefinition as PhoneNumberDefinitions,
ScienceDefinition,
- /** @deprecated Use ScienceDefinition instead */
- ScienceDefinition as ScienceDefinitions,
SystemDefinition,
- /** @deprecated Use SystemDefinition instead */
- SystemDefinition as SystemDefinitions,
SystemMimeTypeEntryDefinition,
- /** @deprecated Use SystemMimeTypeEntryDefinition instead */
- SystemMimeTypeEntryDefinition as SystemMimeTypeEntryDefinitions,
VehicleDefinition,
- /** @deprecated Use VehicleDefinition instead */
- VehicleDefinition as VehicleDefinitions,
WordDefinition,
- /** @deprecated Use WordDefinition instead */
- WordDefinition as WordDefinitions,
} from './definitions';
export { FakerError } from './errors/faker-error';
export { Faker } from './faker';
@@ -85,10 +42,6 @@ export type { AircraftType, AirlineModule } from './modules/airline';
export type { AnimalModule } from './modules/animal';
export { CssFunction, CssSpace } from './modules/color';
export type {
- /** @deprecated Use CssFunctionType instead */
- CssFunctionType as CSSFunction,
- /** @deprecated Use CssSpaceType instead */
- CssSpaceType as CSSSpace,
Casing,
ColorFormat,
ColorModule,
@@ -109,21 +62,12 @@ export type { HackerModule } from './modules/hacker';
export type { HelpersModule, SimpleHelpersModule } from './modules/helpers';
export type { ImageModule } from './modules/image';
export type { InternetModule } from './modules/internet';
-export type {
- /** @deprecated Use LocationModule instead */
- LocationModule as AddressModule,
- LocationModule,
-} from './modules/location';
+export type { LocationModule } from './modules/location';
export type { LoremModule } from './modules/lorem';
export type { MusicModule } from './modules/music';
export type { NumberModule } from './modules/number';
export { Sex } from './modules/person';
-export type {
- /** @deprecated Use PersonModule instead */
- PersonModule as NameModule,
- PersonModule,
- SexType,
-} from './modules/person';
+export type { PersonModule, SexType } from './modules/person';
export type { PhoneModule } from './modules/phone';
export type { ChemicalElement, ScienceModule, Unit } from './modules/science';
export type { StringModule } from './modules/string';
diff --git a/src/locales/base/system/mimeTypes.ts b/src/locales/base/system/mimeTypes.ts
index 05a36193..7b4dd2bc 100644
--- a/src/locales/base/system/mimeTypes.ts
+++ b/src/locales/base/system/mimeTypes.ts
@@ -1,4 +1,4 @@
-import type { SystemDefinitions } from '../../..';
+import type { SystemDefinition } from '../../..';
export default {
'application/epub+zip': {
@@ -240,4 +240,4 @@ export default {
'video/x-msvideo': {
extensions: ['avi'],
},
-} satisfies SystemDefinitions['mimeTypes'];
+} satisfies SystemDefinition['mimeTypes'];