refactor(location)!: throw error if state is unknown

[0916dhkim]

Fixes #1736

• location.zipCodeByState should throw for unknown states #1736

[ST-DDT]

If you have trouble running the tests locally, you can use CI=true pnpm run test watch.

[ST-DDT]

Please throw a FakerError instead.
Maybe also add a list with allowed keys and a hint where these keys are comming from.
E.g. faker.definitions.location.postcode_by_state only contains data for [...]

[matthewmayer]

you might want to have different errors for the

1. where the locale doesn't support postcode_by_state at all (e.g. en, de)
2. where the locale does support postcode_by_state, but this is an unknown state (say XX in en_US).

[ST-DDT]

We will handle the first part centrally: #893 (comment)

• Introduce a way to get details about missing locale data when using them #893

[matthewmayer]

hmm i think this is a weird edge case though where the fallback locale (en) doesn't contain the data, which is unusual.

[0916dhkim]

@ST-DDT Thanks for the review 🙏
I'll use FakeError instead + attach available keys.

[0916dhkim]

I have fixed the code to throw FakerError and updated the docstring, but I'm not sure how to make the tests pass. It looks like en locale is used as default in seededTests, and zipCodeByState will always throw with en.

[matthewmayer]

This documentation needs to be updated to reflect that an error would now be thrown. Also I think it could be make clearer this doesn't work in the default en locale, but only in en_US.

[Shinigami92]

The unresolved conflict brings an issue: the state parameter is required and therefore we have two options:

1. We just allow zipCodeByState({ state: '...', .../* potential other options */ })
2. We allow zipCodeByState({ state: '...', .../* potential other options */ }) as well as zipCodeByState('state', { /* potential other options */ })

Once we said we only want to have method calls (outside the helpers module) that can always be called without passing any arguments. In this case state is always required otherwise it would always throw an error.

We will discuss this in an upcoming meeting.

[ST-DDT]

Team Decision

• We want to merge zipCode and zipCodeByState into a single method instead (Check modules and methods regarding their name and location #1346 (comment))
• It will still throw an error if the state doesn't have a config.

---

Thanks for your contribution anyway!