flattenObject

• flattenObject

オブジェクトobjを受け取り、ネストされたオブジェクトの列挙可能なプロパティを深さ優先でトラバースし、フィールドパス文字列をキーとし、対応する値を値とする平坦化された新しいオブジェクトを返します。

Added in v0.0.4

Usage

import { flattenObject } from 'parsnip-kit'

const input0 = {
  a: [1, 2, { b: 3 }],
  c: {
    d: [4, 5, { e: 6 }]
  }
}
flattenObject(input0)
// {
//   'a[0]': 1,
//   'a[1]': 2,
//   'a[2].b': 3,
//   'c.d[0]': 4,
//   'c.d[1]': 5,
//   'c.d[2].e': 6
// }

const input1 = {
  a: {},
  b: [],
  c: {
    d: {},
    e: []
  }
}
flattenObject(input1) // {}

API

Type Parameter

Arg	Type	Description
T	extends object	平坦化されるオブジェクトの型

Arguments

Arg	Type	Optional	Default	Description
obj	T	false	undefined	平坦化されるオブジェクト

Returns

Type
FlattenNestObject<T>

Reference

FlattenNestObject