feat: add exclude option to faker.helpers.enumValue - #3959
Open
hazrid93 wants to merge 1 commit into
Open
Conversation
✅ Deploy Preview for fakerjs ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
ST-DDT
previously requested changes
Jul 20, 2026
ST-DDT
left a comment
ST-DDT
left a comment
Member
There was a problem hiding this comment.
CI is failing. Please run pnpn run preflight before commiting.
ST-DDT
marked this pull request as draft
July 20, 2026 11:57
hazrid93
force-pushed
the
hazrid93/82_2994
branch
from
July 20, 2026 12:36
88c9e9d to
4e5470c
Compare
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## next #3959 +/- ##
==========================================
- Coverage 98.91% 98.88% -0.03%
==========================================
Files 923 924 +1
Lines 3223 3228 +5
Branches 567 587 +20
==========================================
+ Hits 3188 3192 +4
- Misses 31 32 +1
Partials 4 4
🚀 New features to boost your workflow:
|
hazrid93
force-pushed
the
hazrid93/82_2994
branch
from
July 20, 2026 12:52
4e5470c to
7515bb3
Compare
Closes faker-js#2994. Add an optional `exclude` option (`enumValue(enumObject, { exclude: [...] })`): values in `exclude` are not eligible to be picked. If exclude removes every enum value, a FakerError is thrown. The default behavior (no exclude / empty exclude) is unchanged.
hazrid93
force-pushed
the
hazrid93/82_2994
branch
from
July 20, 2026 13:50
7515bb3 to
81487f2
Compare
ST-DDT
marked this pull request as ready for review
July 20, 2026 13:58
ST-DDT
added
c: feature
Contributor
There was a problem hiding this comment.
Pull request overview
This PR extends faker.helpers.enumValue to support excluding specific enum values from selection, aligning the helper with common seeding/use-case needs (e.g., avoiding a particular enum member during generation).
Changes:
- Added an optional
optionsparameter withexcludeto filter out ineligible enum values before selection. - Added a dedicated error path when no enum values remain after applying
exclude. - Updated JSDoc to document the new option and thrown error condition.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+1104
to
+1108
| .filter((key) => !exclude.includes(enumObject[key] as T[keyof T])); | ||
| if (keys.length === 0) { | ||
| throw new FakerError( | ||
| 'No enum value is available to pick from after applying the exclude option.' | ||
| ); |
| /** | ||
| * The values to exclude when picking. | ||
| */ | ||
| exclude?: Array<T[keyof T]>; |
Comment on lines
+1100
to
+1106
| const exclude = options?.exclude ?? []; | ||
| // ignore numeric keys added by TypeScript | ||
| const keys: Array<keyof T> = Object.keys(enumObject).filter((key) => | ||
| Number.isNaN(Number(key)) | ||
| ); | ||
| const keys: Array<keyof T> = Object.keys(enumObject) | ||
| .filter((key) => Number.isNaN(Number(key))) | ||
| .filter((key) => !exclude.includes(enumObject[key] as T[keyof T])); | ||
| if (keys.length === 0) { | ||
| throw new FakerError( |
Member
|
Could you please address the feedback provided by copilot? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #2994.
Add an optional
excludeoption (enumValue(enumObject, { exclude: [...] })): values inexcludeare not eligible to be picked. If exclude removes every enum value, a FakerError is thrown. The default behavior (no exclude / empty exclude) is unchanged.