field-modifier v1.3.0

field-modifier

A library for modifying nested fields/properties in javascript objects.

• Install
• Import
• Examples
• Api

Install

npm install field-modifier

Import in project

import fieldModifier from "field-modifier"

Examples

Simple field deletion

import { deleteFields } from "field-modifier"

// Remove key from nested object
const result = deleteFields(["fieldOne", "fieldTwo"], {
    "fieldOne": "test",
    "fieldTwo": "test",
    "fieldThree": "test"
})

console.log(JSON.stringify(result))
/* Returns 
{
  "fieldThree":"test"
}
*/

Remove fields in deep nested object

import { deleteFields } from "field-modifier"

// Remove key from nested object
const result = deleteFields(["fieldOne"], {
    "fieldOne": "test",
    "fieldNested": {
        "fieldTwo": "test",
        "fieldOne": "test",
        "fieldThree": "test",
        "nestedNestedField": {
            "fieldFour": [
                {
                    "fieldThree": "test",
                    "fieldTwo": "test",
                    "fieldOne": "test"
                }
            ],
            "fieldThree": "test",
            "fieldTwo": "test",
            "fieldOne": {
                "nestedNestedNestedField": "test"
            },
        }
    }
})

console.log(JSON.stringify(result))
/* Returns
{
  "fieldNested": {
    "fieldTwo": "test",
    "fieldThree": "test",
    "nestedNestedField": {
      "fieldFour": [
        {
          "fieldThree":"test",
          "fieldTwo":"test"
        }
      ],
      "fieldThree":"test",
      "fieldTwo":"test"
    }
  }
}
*/

Replace fields in deep nested object

import { replaceFields } from "field-modifier"

const result = replaceFields({
    "fieldOne": "notFieldOne",
    "fieldTwo": "notFieldTwo"
}, {
    fieldOne: "test",
    fieldTwo: "test",
    fieldThree: {
        fieldOne: "test",
        fieldTwo: {
            someArray: [
                {
                    fieldOne: "test",
                    fieldTwo: "test"
                },
                {
                    fieldOne: "test",
                    fieldTwo: "test"
                }
            ]
        }
    }
})

console.log(JSON.stringify(result))

/* Returns
{
    "fieldThree": {
        "notFieldOne": "test",
        "notFieldTwo": {
            "someArray": [
                {
                    "notFieldOne": "test",
                    "notFieldTwo": "test"
                },
                {
                    "notFieldOne": "test",
                    "notFieldTwo": "test"
                }
            ]
        }
    },
    "notFieldOne": "test",
    "notFieldTwo": "test"
}
*/

Api

deleteFields

Remove one or more fields from an object (supports nested objects).

Function signature:

function deleteFields(keys: Array<string | number>, object: object, deepCopy = true, keepEmpty = false)

Arguments:
keys: An array defining all keys that should be removed from the object
object: Either a javascript object or an array
deepCopy: If false the object field will be mutated directly
keepEmpty: If any null/undefined values are encountered in the object they are removed

replaceFields

Replace one ore more fields from object (supports nested objects).
Note: This funcion currently doesn't support typescript return type meaning that the current return type is any

Function signature:

function replaceFields(replacements: Record<string, string>, object: object, deepCopy = true, keepEmpty = false)

Arguments:
replacements: A js object where the key is the current value and the value is the the replacement key name
object: Either a javascript object or an array
deepCopy: If false the object field will be mutated directly
keepEmpty: If any null/undefined values are encountered in the object they are removed

selectFields

Create a new object from the given object but only include the given fields

Function signature:

function selectFields(keys: Array<string | number>, object: object, parentObject?: object):

Arguments:
keys: A list containing the keys of the fields that should be included
object: A javascript object or array