Add 'path' parameter to the mapper function #48
Conversation
index.d.ts
Outdated
| @@ -85,6 +86,9 @@ const newObject = mapObject({FOO: true, bAr: {bAz: true}}, (key, value) => [key. | |||
|
|
|||
| const newObject = mapObject({one: 1, two: 2}, (key, value) => value === 1 ? [key, value] : mapObjectSkip); | |||
| //=> {one: 1} | |||
|
|
|||
| const newObject = mapObject({foo: {bar: [2], baz: [1, 2, 3]}}, (key, value, source, path) => path.join('.') === 'foo.baz' ? [key, 3] : [key, value], {deep: true}); | |||
There was a problem hiding this comment.
Does this address previous comment? https://github.com/sindresorhus/map-obj/pull/43/files#r884234195
|
|
||
| For arrays, the key is the index of the element being mapped. | ||
|
|
||
| ```js |
There was a problem hiding this comment.
Let me know if this simplified example is ok, in response to https://github.com/sindresorhus/map-obj/pull/43/files#r884235030
|
|
||
| console.log(result); | ||
| //=> {foo: {bar:[2], baz: [3, 3, 3]}} | ||
| ``` |
There was a problem hiding this comment.
Readme and index.d.ts should be in sync.
There was a problem hiding this comment.
I took this to mean you want the path annotated in the definition file, let me know if I misunderstood.
Co-authored-by: Sindre Sorhus <[email protected]>
|
|
||
| console.log(result); | ||
| //=> {foo: {bar:[2], baz: [3, 3, 3]}} | ||
| */ |
| @example | ||
| import mapObject from 'map-obj'; |
There was a problem hiding this comment.
| @example | |
| import mapObject from 'map-obj'; | |
| @example | |
| import mapObject from 'map-obj'; | |
| /** | ||
| When using `deep: true`, this is the sequence of keys to reach the current value from the `source`, otherwise it is an empty array. | ||
| For arrays, the key is the index of the element being mapped. | ||
| @example |
There was a problem hiding this comment.
The example needs to be wrapped in a codeblock.
| import mapObject from 'map-obj'; | ||
|
|
||
| const object = {foo: {bar: [2], baz: [1, 2, 3]}} | ||
| const mapper = (key, value, source, path) => path.join(".") === "foo.baz" ? [key, 3] : [key, value]; |
There was a problem hiding this comment.
Single-quotes, as commented earlier.
| const result = mapObject(object, mapper, {deep: true}); | ||
|
|
||
| console.log(result); | ||
| //=> {foo: {bar:[2], baz: [3, 3, 3]}} |
There was a problem hiding this comment.
| //=> {foo: {bar:[2], baz: [3, 3, 3]}} | |
| //=> {foo: {bar: [2], baz: [3, 3, 3]}} |
| ); | ||
| }); | ||
|
|
||
| test('mapper argument `path` contains the sequence of keys to reach the current value from the source', t => { |
Hi @sindresorhus ,
I'm completing the abandoned PR : #43 , thank you @leonardoraele for doing most of the work.
I'd love to have the
pathavailable in the mapper, too. I've hopefully address your comments in the original PR, I'll outline them in this PR.