flattenObject

Flattens a nested object into a single-level object with dot-separated keys.

• Arrays are flattened.
• Non-plain objects, like Buffers or TypedArrays, are not flattened.

Signature

function flattenObject(object: object, { delimiter = '.' }: FlattenObjectOptions = {}): Record<string, any>;

Parameters

• object (object): The object to flatten.
• delimiter (string): The delimiter to use between nested keys. Defaults to '.'.

Returns

(T): The flattened object.

Examples

const nestedObject = {
  a: {
    b: {
      c: 1,
    },
  },
  d: [2, 3],
};

const flattened = flattenObject(nestedObject);
console.log(flattened);
// Output:
// {
//   'a.b.c': 1,
//   'd.0': 2,
//   'd.1': 3
// }

const flattened = flattenObject(nestedObject, { delimiter: '/' });
console.log(flattened);
// Output:
// {
//   'a/b/c': 1,
//   'd/0': 2,
//   'd/1': 3
// }