Deep-pick and deep-omit objects with typesafe paths.
Both deepPick
and deepOmit
take an object and an array of dot-notation paths to respectively pick and omit from the object. By default, TypeScript will infer types for paths and error if a path does not exist in the object.
import { deepPick } from 'deep-pick-omit'
const obj = {
a: {
b: 'this',
c: 'not this'
},
d: 'this'
}
deepPick(obj, ['a.b', 'e'])
// -> { a: { b: 'this' }, d: 'this' }
deepPick(obj, ['f'])
// -> TypeScript Error: `f` is not a key of `obj`
import { deepOmit } from 'deep-pick-omit'
const obj = {
a: {
b: 'this',
c: 'not this'
},
d: 'this'
}
deepOmit(obj, ['a.c'])
// -> { a: { b: 'this' }, d: 'this' }
deepOmit(obj, ['f'])
// -> TypeScript Error: `f` is not a key of `obj`
Note
Pathing through array values is not allowed typesafe path methods. See unsafe methods.
If paths type-safety is a problem for some edge cases, the package exposes the same methods without the type-checking on paths.
import { deepPickUnsafe } from 'deep-pick-omit'
const obj = {
a: {
c: 'not this'
},
d: 'this'
}
deepPickUnsafe(obj, ['d', 'f'])
// -> { d: 'this' }
import { deepOmitUnsafe } from 'deep-pick-omit'
const obj = {
a: {
b: 'this',
c: 'not this'
},
d: 'this'
}
deepOmitUnsafe(obj, ['a.c', 'f'])
// -> { a: { b: 'this' }, d: 'this' }
MIT — Made with 💖.