Add mapObject.mapObjectSkip for removing object keys
#38
Conversation
index.d.ts
Outdated
| @@ -45,6 +45,8 @@ declare namespace mapObject { | |||
| */ | |||
| shouldRecurse?: boolean; | |||
| } | |||
|
|
|||
| export type mapObjSkip = symbol | |||
There was a problem hiding this comment.
This is not correct. I would recommend reading up on unique symbol in TypeScript.
There was a problem hiding this comment.
I saw it implemented at https://github.com/sindresorhus/p-map/blob/main/index.d.ts#L93 and I found the docs for it at https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-7.html#unique-symbol.
But this is not an ES Module yet, so we can't just do this, right?
export const mapObjectSkip: unique symbol;I think we need to define the mapObjectSkip on the mapObject namespace, and I tried several approaches, but couldn't get it to work.
How would you do it?
There was a problem hiding this comment.
Just use declare const at the top-level to declare the unique symbol and then add it to the namespace.
|
You need to add proper readme docs for the symbol, including description on how it should be used and what it does. |
addresses #38
done via a5342ee |
|
The pull request also needs a proper title. |
gr2m
changed the title
mapObject.mapObjSkipmapObject.mapObjectSkip for removing object keys
I changed it but feel free to change it to your own liking, that's what I do for outside contributions in my own projects. |
| @@ -65,6 +67,9 @@ const newObject = mapObject({FOO: true, bAr: {bAz: true}}, (key, value) => [key. | |||
|
|
|||
| const newObject = mapObject({FOO: true, bAr: {bAz: true}}, (key, value) => [key.toLowerCase(), value], {deep: true}); | |||
| //=> {foo: true, bar: {baz: true}} | |||
|
|
|||
| const newObject = mapObject({one: 1, two: 2}, (key, value) => value === 1 ? [key, value] : mapObject.mapObjectSkip); | |||
| //=> {one: 1} | |||
There was a problem hiding this comment.
The example could be in the symbol doc comment.
There was a problem hiding this comment.
It is
/**
Return this value from a `mapper` function to remove a key from an object.
```js
const mapObject = require('map-obj');
const object = {one: 1, two: 2}
const mapper = (key, value) => value === 1 ? [key, value] : mapObject.mapObjectSkip
const result = mapObject(object, mapper);
console.log(result);
//=> {one: 1}
```
*/
const mapObjectSkip: typeof UniqueSymbol
index.d.ts
Outdated
| } | ||
|
|
||
| // unique symbol cannot be declared in a namespace directly, so we declare it top-level | ||
| // See: https://github.com/sindresorhus/map-obj/pull/38#discussion_r702396878 | ||
| declare const UniqueSymbol: unique symbol; |
There was a problem hiding this comment.
It should still have a descriptive name and be camel-cased.
There was a problem hiding this comment.
camel cased via 358fafd.
It's only used internally, and for that I think it's perfectly descriptive? Can you rename it yourself to whatever you prefer at this point?
There was a problem hiding this comment.
Even it's internally, it's good to have descriptive names. You don't call all your variables const variable1 = …; const variable2 .... But it's not a problem. I can clean it up later.
|
Thanks :) |
closes #36
I need help with the types please. The setup is different from https://github.com/sindresorhus/p-map/blob/main/index.d.ts, and I wasn't able to figure out how to define the types for the
mapObject.mapObjSkipsymbol