From d6f9c480befe4b4364ff553f3bb6a8682d62efeb Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Sat, 2 Apr 2022 23:19:18 +0200 Subject: [PATCH] chore: address zipCodeByState fix types --- src/address.ts | 13 ++++++------- src/definitions/address.ts | 5 +---- src/locales/ar/address/index.ts | 2 -- src/locales/ar/address/postcode_by_state.ts | 1 - src/locales/en/address/index.ts | 2 -- src/locales/en/address/postcode_by_state.ts | 1 - src/locales/he/address/index.ts | 2 -- src/locales/he/address/postcode_by_state.ts | 1 - src/locales/ur/address/index.ts | 2 -- src/locales/ur/address/postcode_by_state.ts | 1 - test/address.spec.ts | 6 +++--- 11 files changed, 10 insertions(+), 26 deletions(-) delete mode 100644 src/locales/ar/address/postcode_by_state.ts delete mode 100644 src/locales/en/address/postcode_by_state.ts delete mode 100644 src/locales/he/address/postcode_by_state.ts delete mode 100644 src/locales/ur/address/postcode_by_state.ts diff --git a/src/address.ts b/src/address.ts index d8dfbbbb2ee..246f4d9b455 100644 --- a/src/address.ts +++ b/src/address.ts @@ -84,8 +84,8 @@ export class Address { } /** - * Generates random zipcode from specified format. If format is not specified, the - * locale's zip format is used. + * Generates random zip code from specified format. If format is not specified, + * the locale's zip format is used. * * @param format The optional format used to generate the the zip code. * By default, a random format is used from the locale zip formats. @@ -111,7 +111,7 @@ export class Address { } /** - * Generates random zipcode from state abbreviation. If state abbreviation is + * Generates random zip code from state abbreviation. If state abbreviation is * not specified, a random zip code is generated according to the locale's zip format. * Only works for locales with postcode_by_state definition. If a locale does not * have a postcode_by_state definition, a random zip code is generated according @@ -123,11 +123,10 @@ export class Address { * fakerUS.address.zipCodeByState("AK") // '99595' * fakerUS.address.zipCodeByState("??") // '47683-9880' */ - zipCodeByState(state: string): string | number { - const zipRange = this.faker.definitions.address.postcode_by_state[state]; + zipCodeByState(state: string): string { + const zipRange = this.faker.definitions.address.postcode_by_state?.[state]; if (zipRange) { - // TODO ST-DDT 2022-02-10: Fix types - return this.faker.datatype.number(zipRange); + return String(this.faker.datatype.number(zipRange)); } return this.faker.address.zipCode(); } diff --git a/src/definitions/address.ts b/src/definitions/address.ts index d34bc0bd74f..24f9b7cc81d 100644 --- a/src/definitions/address.ts +++ b/src/definitions/address.ts @@ -7,10 +7,7 @@ export interface AddressDefinitions { /** * Postcodes patterns by state */ - // TODO ST-DDT 2022-01-31: address.zipCodeByState() expects only { [state: string]: { min: number; max: number } } - postcode_by_state: - | string[] - | { [state: string]: { min: number; max: number } }; + postcode_by_state: { [state: string]: { min: number; max: number } }; /** * Postcodes patterns (Fake-Pattern | Fake-Pattern[]). */ diff --git a/src/locales/ar/address/index.ts b/src/locales/ar/address/index.ts index 4506fbc8c84..7789c0e5f5b 100644 --- a/src/locales/ar/address/index.ts +++ b/src/locales/ar/address/index.ts @@ -9,7 +9,6 @@ import city_name from './city_name'; import country from './country'; import default_country from './default_country'; import postcode from './postcode'; -import postcode_by_state from './postcode_by_state'; import secondary_address from './secondary_address'; import state from './state'; import street_address from './street_address'; @@ -23,7 +22,6 @@ const address = { country, default_country, postcode, - postcode_by_state, secondary_address, state, street_address, diff --git a/src/locales/ar/address/postcode_by_state.ts b/src/locales/ar/address/postcode_by_state.ts deleted file mode 100644 index 4433f068b5e..00000000000 --- a/src/locales/ar/address/postcode_by_state.ts +++ /dev/null @@ -1 +0,0 @@ -export default ['#####', '#####-####']; diff --git a/src/locales/en/address/index.ts b/src/locales/en/address/index.ts index efb55311d33..78cb3ec842c 100644 --- a/src/locales/en/address/index.ts +++ b/src/locales/en/address/index.ts @@ -16,7 +16,6 @@ import default_country from './default_country'; import direction from './direction'; import direction_abbr from './direction_abbr'; import postcode from './postcode'; -import postcode_by_state from './postcode_by_state'; import secondary_address from './secondary_address'; import state from './state'; import state_abbr from './state_abbr'; @@ -39,7 +38,6 @@ const address = { direction, direction_abbr, postcode, - postcode_by_state, secondary_address, state, state_abbr, diff --git a/src/locales/en/address/postcode_by_state.ts b/src/locales/en/address/postcode_by_state.ts deleted file mode 100644 index 4433f068b5e..00000000000 --- a/src/locales/en/address/postcode_by_state.ts +++ /dev/null @@ -1 +0,0 @@ -export default ['#####', '#####-####']; diff --git a/src/locales/he/address/index.ts b/src/locales/he/address/index.ts index 04ed969dd15..bcf2af271c3 100644 --- a/src/locales/he/address/index.ts +++ b/src/locales/he/address/index.ts @@ -13,7 +13,6 @@ import default_country from './default_country'; import direction from './direction'; import direction_abbr from './direction_abbr'; import postcode from './postcode'; -import postcode_by_state from './postcode_by_state'; import secondary_address from './secondary_address'; import state from './state'; import state_abbr from './state_abbr'; @@ -33,7 +32,6 @@ const address = { direction, direction_abbr, postcode, - postcode_by_state, secondary_address, state, state_abbr, diff --git a/src/locales/he/address/postcode_by_state.ts b/src/locales/he/address/postcode_by_state.ts deleted file mode 100644 index 2850dba4057..00000000000 --- a/src/locales/he/address/postcode_by_state.ts +++ /dev/null @@ -1 +0,0 @@ -export default ['#####', '#######']; diff --git a/src/locales/ur/address/index.ts b/src/locales/ur/address/index.ts index 312e90271ab..a04af9074df 100644 --- a/src/locales/ur/address/index.ts +++ b/src/locales/ur/address/index.ts @@ -12,7 +12,6 @@ import country from './country'; import default_country from './default_country'; import direction from './direction'; import postcode from './postcode'; -import postcode_by_state from './postcode_by_state'; import secondary_address from './secondary_address'; import state from './state'; import state_abbr from './state_abbr'; @@ -30,7 +29,6 @@ const address = { default_country, direction, postcode, - postcode_by_state, secondary_address, state, state_abbr, diff --git a/src/locales/ur/address/postcode_by_state.ts b/src/locales/ur/address/postcode_by_state.ts deleted file mode 100644 index db2bcfedae5..00000000000 --- a/src/locales/ur/address/postcode_by_state.ts +++ /dev/null @@ -1 +0,0 @@ -export default ['#####']; diff --git a/test/address.spec.ts b/test/address.spec.ts index 1b9877619d9..f7ee4cacb8c 100644 --- a/test/address.spec.ts +++ b/test/address.spec.ts @@ -395,15 +395,15 @@ describe('address', () => { faker.locale = 'en_US'; const states = ['IL', 'GA', 'WA']; - const zipCode1 = faker.address.zipCodeByState(states[0]); + const zipCode1 = +faker.address.zipCodeByState(states[0]); expect(zipCode1).greaterThanOrEqual(60001); expect(zipCode1).lessThanOrEqual(62999); - const zipCode2 = faker.address.zipCodeByState(states[1]); + const zipCode2 = +faker.address.zipCodeByState(states[1]); expect(zipCode2).greaterThanOrEqual(30001); expect(zipCode2).lessThanOrEqual(31999); - const zipCode3 = faker.address.zipCodeByState(states[2]); + const zipCode3 = +faker.address.zipCodeByState(states[2]); expect(zipCode3).greaterThanOrEqual(98001); expect(zipCode3).lessThanOrEqual(99403); });