picklyfy
v1.0.0
Published
Tiny TypeScript utility to pick or omit keys from objects, with optional deep (dot-path) support.
Downloads
4
Maintainers
Readme
picklyfy
Tiny TypeScript utility to pick or omit keys from objects, with optional deep (dot-path) support.
Install
npm install picklyfy
# or
yarn add picklyfyUsage
import picklyfy, { pick, omit } from "picklyfy";
const data = {
id: 1,
user: { name: "Vinod", email: "[email protected]" },
meta: { tags: ["js", "ts"] }
};
// pick shallow keys
const a = pick(data, ["id"]);
// => { id: 1 }
// pick deep path
const b = pick(data, ["user.name", "meta.tags"], { deep: true });
// => { user: { name: 'Vinod' }, meta: { tags: ['js','ts'] } }
// omit shallow
const c = omit(data, ["meta"]);
// => { id:1, user: { name: 'Vinod', email: '[email protected]' } }
// convenience
const d = picklyfy(data, ["user.name"], { deep: true, mode: "pick" });API
pick(obj, keys, { deep?: boolean })- returns object with only selected keysomit(obj, keys, { deep?: boolean })- returns object without selected keyspicklyfy(obj, keys, { deep?: boolean, mode?: "pick" | "omit" })- wrapper
Build
npm install
npm run buildLicense
🪪 License
MIT © 2025 Vinod Selvin
