@npmteam2024/est-eveniet-deserunt

Table of Contents

• Getting Started
• Installation
• Features
• Usage
• Examples
• License

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 @npmteam2024/est-eveniet-deserunt using npm:

1npm install @npmteam2024/est-eveniet-deserunt

or yarn:

1yarn add @npmteam2024/est-eveniet-deserunt

or pnpm:

1pnpm add @npmteam2024/est-eveniet-deserunt

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

1import { deepObjectKeyAlternator } from "@npmteam2024/est-eveniet-deserunt"

CommonJS (CJS) Import

1const { deepObjectKeyAlternator } = require("@npmteam2024/est-eveniet-deserunt")

Examples

For Objects (with intellisense support)

1import { deepObjectKeyAlternator } from "@npmteam2024/est-eveniet-deserunt"
2// or const { deepObjectKeyAlternator } = require("@npmteam2024/est-eveniet-deserunt")
3
4// Define your input object
5const inputObject = {
6  id: 95,
7  name: "Your Input Data",
8  // ... Your input data ...
9}
10
11// Use deepObjectKeyAlternator to parse the object
12const parsedObject = deepObjectKeyAlternator(inputObject, {
13  id: "customId",
14  name: "customName",
15  // ... Your key mapping ...
16})
17
18console.log(parsedObject)
19// {
20//   customId: 95,
21//   customName: 'Your Input Data',
22//   // ... Your input data ...
23// }

For Arrays (without intellisense support)

1import { deepObjectKeyAlternator } from "@npmteam2024/est-eveniet-deserunt"
2// or const { deepObjectKeyAlternator } = require("@npmteam2024/est-eveniet-deserunt");
3
4// Define an array of objects
5const inputArray = [
6  {
7    id: 1,
8    name: "Item 1",
9  },
10  {
11    id: 2,
12    name: "Item 2",
13  },
14  // ... More items ...
15]
16
17// Use deepObjectKeyAlternator to parse the array of objects
18const parsedArray = inputArray.map((item) => {
19  return deepObjectKeyAlternator(item, {
20    id: "customId",
21    name: "customName",
22    // ... Your key mapping ...
23  })
24})
25
26console.log(parsedArray)
27// [
28//   {
29//     customId: 1,
30//     customName: 'Item 1',
31//     // ... Your input data ...
32//   },
33//   {
34//     customId: 2,
35//     customName: 'Item 2',
36//     // ... Your input data ...
37//   },
38//   // ... More items ...
39// ]

License

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