Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Don't use deprecated phone.numer(format) parameter as an example for faker.helpers.fake #2580

Closed
matthewmayer opened this issue Dec 17, 2023 · 2 comments · Fixed by #2668
Closed

Don't use deprecated phone.numer(format) parameter as an example for faker.helpers.fake #2580

matthewmayer opened this issue Dec 17, 2023 · 2 comments · Fixed by #2668
Assignees
@matthewmayer
Labels
c: docs Improvements or additions to documentation m: helpers Something is referring to the helpers module p: 1-normal Nothing urgent
Milestone
vAnytime

Comments

@matthewmayer
Copy link
Contributor

matthewmayer commented Dec 17, 2023 •
edited
Loading

faker/src/modules/helpers/index.ts

Line 1420 in 8013fa0

* const message = faker.helpers.fake('You can call me at {{phone.number(+!# !## #### #####!)}}.');

We should replace this example with one that doesn't use a deprecated parameter.
@ST-DDT ST-DDT added this to the vAnytime milestone Dec 17, 2023
@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent m: helpers Something is referring to the helpers module labels Dec 17, 2023
@matthewmayer matthewmayer self-assigned this Dec 17, 2023
@matthewmayer
Copy link
Contributor Author

How about this, shows quoted strings, unquoted strings, and JSON

faker.helpers.fake('My sister {{person.firstName(female)}} and my brother {{person.firstName("male")}} live at {{location.streetAddress({ "useFullAddress": true })}}')

@ST-DDT
Copy link
Member

ST-DDT commented Feb 24, 2024

Fixed in #2668

@ST-DDT ST-DDT closed this as completed Feb 24, 2024
@ST-DDT ST-DDT linked a pull request Feb 24, 2024 that will close this issue
docs: more jsdoc fixes #2668
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@matthewmayer matthewmayer

Labels
c: docs Improvements or additions to documentation m: helpers Something is referring to the helpers module p: 1-normal Nothing urgent
Projects
None yet
Milestone
vAnytime
Development

Successfully merging a pull request may close this issue.

docs: more jsdoc fixes faker-js/faker
2 participants
@matthewmayer @ST-DDT