faker
faker copied to clipboard
faker-js
Extend Docs to Describe Expected Usage with TypeScript
[!NOTE] The updated requirements for the issues can be found in this comment.
Pre-Checks
- [X] Follow our Code of Conduct.
- [X] Read the Contributing Guidelines.
- [X] Read the docs.
- [X] Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
- [X] Make sure this is a Faker issue and not related to a combination with another package.
- [X] Check that this is a concrete bug. For Q&A open a GitHub Discussion or join our Discord Chat Server.
- [X] The provided reproduction is a minimal reproducible example of the bug.
- [X] I am willing to provide a PR.
Describe the bug
In a project where TypeScript is not configured to run in strict mode, the function faker.helpers.arrayElement can be called with null and undefined, which leads to errors during runtime.
Minimal reproduction code
https://stackblitz.com/edit/faker-js-demo-c67mtj?file=index.ts
Additional Context
This might be true for ALL functions, as null is assignable to everything in non-strict mode.
- This configuration was not discussed in https://github.com/faker-js/faker/issues/2725#issuecomment-2012927210.
Environment Info
-
Which module system do you use?
- [X] CJS
- [X] ESM
Used Package Manager
pnpm
IMO we clearly define our needs/requirements. If you choose to ignore them using js, non strict ts or unsafe casts, then you are on your own.
IMO we clearly define our needs/requirements. If you choose to ignore them using js, non strict ts or unsafe casts, then you are on your own.
I don't know if I agree with this statement, especially since TypeScripts default is still non-strict mode.
Team Decision
- We assume that the user either uses strict TypeScript or handles the issues arising from not using it themselves.
Can you please explain to me what exactly do i have to do, like do i have to types for this ?
@AmaanRS I'm not sure if I understand correctly. Are you asking for the tasks to do to work on the issue? 🤔
Can you please explain to me what exactly do i have to do, like do i have to types for this ?
@AmaanRS This is a documentation task, so it doesn't need any code changes.
@xDivisionByZerox I'm not exactly sure what should be done for this issue either. Could you please explain what documentation do you want where?
@xDivisionByZerox I'm not exactly sure what should be done for this issue either. Could you please explain what documentation do you want where?
Of couse. IMO the TypeScript section of our docs should add a note box hinting the user that using faker without (TS) strict mode might lead to unexpected behaviour which will not be worked around from our side.