Data mapping can be a challenging and complex task, especially when dealing with nested data structures, arrays, and deeply nested objects. In scenarios where you need to restructure or transform data from one format to another, the complexity can quickly become overwhelming. This is where the Remap.JS library comes to the rescue.

https://www.npmjs.com/package/@trinly01/remap.js

Remap.JS Library Tutorial

The Remap.JS library is a versatile JavaScript utility that simplifies data transformation, making it suitable for a wide range of use cases. In this tutorial, we'll explore how to use the library to remap and notate data, allowing you to transform complex data structures easily.

Table of Contents

• Installation
• Remap Function
• Notate Function
• Tutorial Example

Installation

To get started with the Remap.JS library, you'll need to install it into your project. You can install it using npm or yarn:

npm install @trinly01/remap.js
# or
yarn add @trinly01/remap.js

Once the library is installed, you can import it into your JavaScript file.

import { remap, notate } from '@trinly01/remap.js';

Remap Function

The remap function allows you to transform an array of objects into a new array with the mapped data according to the specified key mapping configuration. It's a powerful tool for simplifying complex data structures.

Usage:

const transformedData = remap(sourceArray, keyMap);

• sourceArray (Array): The array of source objects to remap.
• keyMap (Object): The key mapping configuration defining how to map the source data to the destination object.

Notate Function

The notate function is used to create and assign values to objects with specific key notations. It's highly flexible and adaptable for various use cases.

Usage:

notate(notation, value, result);

• notation (String or Object): The key notation in the destination object. If it's an object, you can set multiple values at once. If it's a single path notation (string), the value parameter is required.
• value (Any): The value to assign to the destination object. Required when notation is a single path notation (string).
• result (Object, optional): The result object where the data will be assigned.

Tutorial Example

Let's put the Remap.JS library to use with a simple example:

import { remap, notate } from '@trinly01/remap.js';

const sourceArray = [
  {
    id: 1,
    name: 'John Doe',
    contact: {
      email: 'john@work.com',
      phone: '123-456-7890',
    },
  },
  // Add more source data objects here
];

const keyMap = {
  'Profile.id': 'id',
  'Profile.name': 'name',
  'Profile.email': 'contact.email',
  'Profile.phone': 'contact.phone',
};

// Remap the source data
const transformedData = remap(sourceArray, keyMap);

console.log('Transformed Data:\n', transformedData);

// Notate single values
const result = {};
notate('Profile.id', 1, result);
notate('Profile.name', 'John Doe', result);
notate('Profile.email', 'john@work.com', result);
notate('Profile.phone', '123-456-7890', result);

console.log('Result after notating single values:\n', result);

// Notate multiple values using an object
const obj = {};
const multipleValues = {
  'Profile.id': 1,
  'Profile.name': 'John Doe',
  'Profile.email': 'john@work.com',
  'Profile.phone': '123-456-7890',
};

notate(multipleValues, obj);

console.log('Result after notating multiple values:\n', obj);

This example demonstrates how to use the Remap.JS library to remap and notate data, making data transformation tasks simpler and more flexible.

That's it! You've learned how to use the Remap.JS library to streamline data transformation and notating. This versatile utility can be a valuable asset in various data manipulation tasks.