object-mapper-util
TypeScript icon, indicating that this package has built-in type declarations

1.0.10 • Public • Published

object-mapper-util

Description

The object-mapper-util library provides a simple function to map objects based on user-defined configurations.

Installation

To install the library in your project, you can use npm. Run the following command in the terminal:

npm install object-mapper-util

Basic Usage

Here is a basic example of how to use the library:

import { objectMapperUtil, IObjectMapperUtilRefs } from 'object-mapper-util';

const inputObject = {
  prop1: 42,
  prop2: 'Hello',
  prop3: 'Not changed value from input object',
  prop4: {
    prop1: {
        prop: "Value"
    }
  },
  prop5: [
    {
        propElement0: 'element[0]'
    }
  ]
};

const PROPERTIES_REFS: IObjectMapperUtilRefs[] = [
  { outputProp: 'property1', valueProcessor: (value) => value * 2, inputProp: 'prop1' },
  { outputProp: 'property2', defaultValue: 'Default' },
  { outputProp: 'property3', inputProp: 'prop3' },
  { outputProp: 'property4', inputProp: 'prop4.prop1.prop' },
  { outputProp: 'property5', inputProp: 'prop5[0].propElement0' }
];

const mappedObject = objectMapperUtil(inputObject, PROPERTIES_REFS);

console.log(mappedObject);

/*
output:
{
  property1: 84,
  property2: 'Default',
  property3: 'Not changed value from input object',
  property4: 'Value',
  property5: 'element[0]'
}
/*

License

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

I hope the library proves useful in your projects! If you have any questions or issues, feel free to reach out.

Author

Package Sidebar

Install

npm i object-mapper-util

Weekly Downloads

3

Version

1.0.10

License

MIT

Unpacked Size

48.9 kB

Total Files

31

Last publish

Collaborators

  • andredrumond1995