Do not ignore symbol properties #23
Merged
+34
−28
Conversation
This file contains 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
ehmicky
commented
Jul 24, 2022
| for (const key of Object.keys(object)) { | ||
| if (set.has(key)) { | ||
| for (const key of Reflect.ownKeys(object)) { | ||
| if (isEnumerable.call(object, key) && set.has(key)) { |
There was a problem hiding this comment.
Unlike Object.keys(), Reflect.ownKeys() also returns symbols. However, it also returns non-enumerable properties, so we need an additional check.
ehmicky
commented
Jul 24, 2022
| } | ||
| } | ||
| } | ||
|
|
||
| return result; | ||
| } | ||
|
|
||
| const {propertyIsEnumerable: isEnumerable} = Object.prototype; |
There was a problem hiding this comment.
propertyIsEnumerable is also a global function, so the property is renamed to avoid shadowing.
ehmicky
commented
Jul 24, 2022
readme.md
Outdated
| @@ -48,15 +46,15 @@ The source object to filter properties from. | |||
|
|
|||
| #### filter | |||
|
|
|||
| Type: `(sourceKey, sourceValue, source) => boolean` | |||
| Type: `(sourceKey: string | symbol, sourceValue: any, source: object) => boolean` | |||
There was a problem hiding this comment.
Reflect.ownKeys() returns array indices as strings (like Object.keys() does), so sourceKey cannot be a number.
sindresorhus
requested changes
Jul 25, 2022
index.test-d.ts
Outdated
| @@ -1,15 +1,17 @@ | |||
| import {expectType, expectError} from 'tsd'; | |||
| import {includeKeys, excludeKeys} from './index.js'; | |||
|
|
|||
| const propSymbol = Symbol('test'); | |||
There was a problem hiding this comment.
Suggested change
| const propSymbol = Symbol('test'); | |
| const propertySymbol = Symbol('test'); |
Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>
Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>
|
Fixed 👍 |
|
Thanks :) |
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.
Fixes #21.
This ensures symbol properties are kept.
This is a breaking change since the function predicate passed as argument needs to handle the potential case that the key might be a symbol instead of a string.