deep-object-key-alternator
TypeScript icon, indicating that this package has built-in type declarations

1.2.1 • Public • Published

deep-object-key-alternator

npm version Code Size GitHub license Commitizen friendly Jest Tests GitHub Actions/CI npm downloads

Table of Contents

Getting Started

deepObjectKeyAlternator is a versatile utility function that allows you to recursively parse an object or array of objects, applying a key mapping to rename object keys. It's particularly handy when you need to transform the structure of nested objects while preserving the original data.

Installation

You can install deep-object-key-alternator using npm:

npm install deep-object-key-alternator

or yarn:

yarn add deep-object-key-alternator

or pnpm:

pnpm add deep-object-key-alternator

Features

  • Recursively parses nested objects.
  • Customizable key mapping with intellisense support.
  • Supports arrays (without intellisense support).
  • Preserves the structure of arrays.

Usage

Here's how you can use deepObjectKeyAlternator in your projects:

ECMAScript Modules (ESM) Import

import { deepObjectKeyAlternator } from "deep-object-key-alternator"

CommonJS (CJS) Import

const { deepObjectKeyAlternator } = require("deep-object-key-alternator")

Examples

For Objects (with intellisense support)

import { deepObjectKeyAlternator } from "deep-object-key-alternator"
// or const { deepObjectKeyAlternator } = require("deep-object-key-alternator")

// Define your input object
const inputObject = {
  id: 95,
  name: "Your Input Data",
  // ... Your input data ...
}

// Use deepObjectKeyAlternator to parse the object
const parsedObject = deepObjectKeyAlternator(inputObject, {
  id: "customId",
  name: "customName",
  // ... Your key mapping ...
})

console.log(parsedObject)
// {
//   customId: 95,
//   customName: 'Your Input Data',
//   // ... Your input data ...
// }

For Arrays (without intellisense support)

import { deepObjectKeyAlternator } from "deep-object-key-alternator"
// or const { deepObjectKeyAlternator } = require("deep-object-key-alternator");

// Define an array of objects
const inputArray = [
  {
    id: 1,
    name: "Item 1",
  },
  {
    id: 2,
    name: "Item 2",
  },
  // ... More items ...
]

// Use deepObjectKeyAlternator to parse the array of objects
const parsedArray = inputArray.map((item) => {
  return deepObjectKeyAlternator(item, {
    id: "customId",
    name: "customName",
    // ... Your key mapping ...
  })
})

console.log(parsedArray)
// [
//   {
//     customId: 1,
//     customName: 'Item 1',
//     // ... Your input data ...
//   },
//   {
//     customId: 2,
//     customName: 'Item 2',
//     // ... Your input data ...
//   },
//   // ... More items ...
// ]

License

This package is licensed under the MIT License - see the LICENSE file for details.

Dependents (0)

Package Sidebar

Install

npm i deep-object-key-alternator

Weekly Downloads

6

Version

1.2.1

License

MIT

Unpacked Size

23.2 kB

Total Files

13

Last publish

Collaborators

  • emranffl