nested-object-to-key-value
Version:
A lightweight utility to flatten nested JavaScript objects into dot-notation key-value pairs and unflatten them back. Perfect for handling complex configurations, form data, or API transformations.
94 lines (71 loc) • 2.44 kB
Markdown
[](https://github.com/eivindingebrigtsen/nested-object-to-key-value/actions/workflows/ci.yml)
[](https://www.npmjs.com/package/nested-object-to-key-value)
[](https://opensource.org/licenses/MIT)
[](https://www.typescriptlang.org/)
A lightweight utility to flatten nested JavaScript objects into dot-notation key-value pairs and unflatten them back. Perfect for handling complex configurations, form data, or API transformations.
- 🎯 Zero dependencies
- 📦 Lightweight (~XKB gzipped)
- 💪 Fully typed (TypeScript)
- 🔍 Preserves type information
- ⚡ Tree-shakeable
- 🧪 Well tested
## 📦 Installation
```bash
npm install nested-object-to-key-value
```
## 📚 Usage
```ts
import { flattenJson, unflattenJson } from "nested-object-to-key-value";
// Flatten a nested object
const nested = {
user: {
name: "John",
address: {
city: "New York",
country: "USA",
},
},
};
const flattened = flattenJson(nested);
// Result:
// [
// { key: "user.name", value: "John" },
// { key: "user.address.city", value: "New York" },
// { key: "user.address.country", value: "USA" }
// ]
// Unflatten back to nested object
const flat = {
"user.name": "John",
"user.address.city": "New York",
"user.address.country": "USA",
};
const unflattened = unflattenJson(flat);
// Result:
// {
// user: {
// name: "John",
// address: {
// city: "New York",
// country: "USA"
// }
// }
// }
```
Converts a nested object into an array of flattened key-value pairs.
Converts a flat object with dot-notation keys back into a nested object.
Converts an array of key-value pairs into a flat object.
We use [Vitest](https://vitest.dev/) for testing.
```bash
npm test
```
Contributions are welcome! Please open an issue or submit a pull request.
MIT