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

faker.helpers.uniqueArray examples are incomplete and broken #3291

Closed
ST-DDT opened this issue Dec 1, 2024 · 0 comments · Fixed by #3321
Closed

faker.helpers.uniqueArray examples are incomplete and broken #3291

ST-DDT opened this issue Dec 1, 2024 · 0 comments · Fixed by #3321
Assignees
@ST-DDT
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

@ST-DDT
Copy link
Member

ST-DDT commented Dec 1, 2024

faker/src/modules/helpers/index.ts

Lines 666 to 669 in 01e20e9

* @example
* faker.helpers.uniqueArray(faker.word.sample, 50)
* faker.helpers.uniqueArray(faker.definitions.person.first_name, 6)
* faker.helpers.uniqueArray(["Hello", "World", "Goodbye"], 2)

  • The faker.helpers.uniqueArray examples don't have example values.
    grafik

  • The middle example, does not return any useful values
    grafik

Found during the implementation of #3287
@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 1, 2024
@ST-DDT ST-DDT added this to the vAnytime milestone Dec 1, 2024
@ST-DDT ST-DDT self-assigned this Dec 3, 2024
@ST-DDT ST-DDT mentioned this issue Dec 3, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ST-DDT ST-DDT

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(helpers): add missing example results to uniqueArray faker-js/faker
1 participant
@ST-DDT