@blumintinc/flatten-anything

中文文档
4.1.1发布于 2025/06/11MITTypeScriptESM + CJS近 30 天下载 5112

平面对象并用"prop.subprop"来取代嵌入道具. 简单而小的一体化

中文使用文档
文档目录9 节
  1. 通用JS 支持
  2. 与家人相会(在TS支助下,更小的功用)
  3. 使用量
  4. 平面对象
  5. 平整阵列
  6. 将深度限制为平地
  7. 只平整某些道具
  8. 树摇
  9. Firestore 示例

摆平任何东西

Total Downloads Latest Stable Version

npm i flatten-anything

平面对象并用"prop.subprop"来取代嵌入道具. 简单而小的融合.

通用JS 支持

这套方案既提供无害环境管理,也提供共同的JS结构:

// ESM (default)
import { flatten } from 'flatten-anything'

// CommonJS
const { flatten } = require('flatten-anything')

我在寻找:

  • 平整对象阵列的简单解决方案( R)
  • 只有平地物体和 非特殊类来啊!

这最后一个是关键! 如此多的图书馆使用自定义类来创建带有特殊原型的物体,这些物体在试图平分时都会被打破. 所以我们要小心!

平地-任何东西都会平地物体及其巢穴属性,但只要是"平地物体". 一旦一个子道具不是"平面物体",并有一个特殊的原型,它就会停止在那里平地并引用这个实例"如是". ♻️

可用于创建有效载荷 火炉 update 函数, 它只接受平面对象 ! 比如说Firestore公司 Firebase.firestore.FieldValue.delete() 不中断.

可与 筑巢 - 任何东西这和这个完全相反

与家人相会(在TS支助下,更小的功用)

使用量

  • 如果您通过一个对象, 它会平整所有嵌入属性
  • 如果您通过一个阵列, 它会平整所有嵌入阵列

平面对象

import { flatten } from 'flatten-anything'

const target = { name: 'Ho-oh', types: { fire: true, flying: true } }

flatten(target)
// returns {
//   name: 'Ho-oh',
//   types.fire: true,
//   types.flying: true
// }

请注意,当你通过一个物体时,它只会平整嵌入式物体道具,对物体内部的阵列不做任何事情.

平整阵列

import { flatten } from 'flatten-anything'

const target = [1, 2, ['a', 'b', ['y', 'z']], 3]

flatten(target)
// returns [1, 2, 'a', 'b', 'y', 'z', 3]

请注意,当你通过一个阵列时,它只会平整直流阵列,对阵列内的物体不做任何事情.

将深度限制为平地

目前只处理对象。 请打开一个问题, 如果您希望它也能与数组一起工作 !

const target = {
  name: 'Lugia',
  appearence: {
    // let's only flatten 1 level until here:
    parts: { wings: true },
    colors: { white: true, blue: true },
  },
}
const untilDepth = 1

flatten(target, untilDepth)
// returns {
//   name: 'Lugia',
//   appearence.parts: { wings: true },
//   appearence.colors: { white: true, blue: true },
// }

只平整某些道具

仅能平地取出一道道具.

import { flattenObjectProps } from 'flatten-anything'

const target = {
  appearence: { hair: 'orange' },
  traits: { strength: 9000 },
}
const propsToFlatten = ['traits']

flattenObjectProps(target, propsToFlatten)
// returns {
//   appearence: { hair: 'orange' },
//   traits.strength: 9000,
// }

也可以指: 有巢的物体属性,仅能平整出特定的有巢的道具,而将其余部分作为物体保留!

const target = {
  traits: {
    strength: 9000,
    range: { min: 8000, max: 10000 },
  },
}

const propsToFlatten = ['traits.range']
// only flatten `traits.range` and nothing else.

flattenObjectProps(target, propsToFlatten)
// returns {
//   traits: { strength: 9000 },
//   'traits.range': {min: 8000, max: 10000},
// }

树摇

导入 flatten 允许您用于两个对象 财务报告和审定财务报表 数组.

如果使用网络包装、卷起等 导入更少的代码 指定您需要的精确平整函数:

import { flattenObject } from 'flatten-anything'
// or
import { flattenArray } from 'flatten-anything'

Firestore 示例

const pokemon = {
  name: 'Charizard',
  types: { dark: true, fire: true, flying: true },
}
// we want to delete the `dark` type from this Pokemon

const payload = flatten({
  types: { dark: Firebase.firestore.FieldValue.delete() },
})
Firebase.firestore()
  .doc('pokemon/charizard')
  .update(payload)

版本与发布记录

@blumintinc/flatten-anything 共发布 8 个版本,首次发布于 2025/04/06;过去 12 个月发布了 0 个版本。

版本发布日期距今
4.1.1latest2025/06/111.4 年前
4.1.02025/05/241.5 年前
4.0.82025/04/061.6 年前
4.0.72025/04/061.6 年前
4.0.62025/04/061.6 年前
4.0.52025/04/061.6 年前

关于 @blumintinc/flatten-anything 的常见问题

@blumintinc/flatten-anything 是什么?

平面对象并用"prop.subprop"来取代嵌入道具. 简单而小的一体化

如何安装 @blumintinc/flatten-anything?

在项目目录运行 npm install @blumintinc/flatten-anything,或使用 pnpm add / yarn add / bun add。

@blumintinc/flatten-anything 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@blumintinc/flatten-anything 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@blumintinc/flatten-anything 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@blumintinc/flatten-anything 可以商用吗?

@blumintinc/flatten-anything 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@blumintinc/flatten-anything 的下载量有多少?

根据 npm 官方下载统计,@blumintinc/flatten-anything 在 2026/10/09 – 2026/11/07 这 30 天内被下载 5,112 次,日均约 170 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@blumintinc/flatten-anything 还在维护吗?

最新版本 4.1.1 发布于 2025/06/11(1.4 年前);至今共发布 8 个版本,其中过去 12 个月发布了 0 个;首次发布于 2025/04/06。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。