renameKeys.md

renameKeys (source code)

• Curried: true
• Failsafe status: alternative available

The renameKeys function renames specified keys in each object of an array while keeping their values the same. It creates a new instance and does not mutate the original array.

Arguments:

• keyMap: An object where the keys are the original keys of the array of objects and values are the keys to which it should be renamed.

  {
    sourceKey1: "destinationKey1",
    sourceKey2: "destinationKey2",
  }

• entityArray: The array of objects on which the rename function works.

Usage:

const data = [
  { id: 1, name: "Tomato", quantity: 10 },
  { id: 2, name: "Potato", quantity: 20 },
];

// rename name to label and id to value
renameKeys({ name: "label", id: "value" }, data);

/*
output: [
  { label: "Tomato", value: 1, quantity: 10 },
  { label: "Potato", value: 2, quantity: 20 },
];
*/

See also

• copyKeys
• copyKeysDeep