@gulujs/object-path

中文文档
0.6.0发布于 2023/11/12MITTypeScriptES Module零依赖近 30 天下载 2.4万

使用点路径访问嵌入对象属性

中文使用文档
文档目录3 节
  1. 安装
  2. 使用量
  3. 许可证

@ gulijs/ 对象路径

安装

npm install @gulujs/object-path

使用量

import { ObjectPath } from '@gulujs/object-path';

const obj = { foo: [{ bar: 'Hello' }] };

/**
 * default is `escapeDotStyle`
 * `quoteStyle` can access by `ObjectPath.quoteStyle.get(obj, 'foo[0].bar')`
 */
console.log(ObjectPath.get(obj, 'foo[0].bar')); // 'Hello'

ObjectPath.set(obj, 'baz', 'world');
console.log(obj); // { foo: [{ bar: 'Hello' }], baz: 'world' }

ObjectPath.del(obj, 'foo[0].bar');
console.log(obj); // { foo: [{}], baz: 'world' }

console.log(ObjectPath.has(obj, 'foo[0].bar')); // false
console.log(ObjectPath.has(obj, 'foo')); // true

let path = ObjectPath.escapeDotStyle.keyPath.parse('users[0].user\\.name');
console.log(path); // ['users', 0, 'user.name']

let key = ObjectPath.escapeDotStyle.keyPath.stringify(path);
console.log(key); // 'users[0].user\\.name'

path = ObjectPath.quoteStyle.keyPath.parse(`users[0].'user name'`);
console.log(path); // ['users', 0, 'user name']

key = ObjectPath.quoteStyle.keyPath.stringify(path);
console.log(key); // `users[0].'user name'`

许可证

麻省理工学院

版本与发布记录

@gulujs/object-path 共发布 5 个版本,首次发布于 2022/11/27;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.6.0latest2023/11/123 年前
0.5.02023/05/283 年前
0.4.12023/03/213 年前
0.4.02022/12/293 年前
0.3.02022/11/273 年前

关于 @gulujs/object-path 的常见问题

@gulujs/object-path 是什么?

使用点路径访问嵌入对象属性

如何安装 @gulujs/object-path?

在项目目录运行 npm install @gulujs/object-path,或使用 pnpm add / yarn add / bun add。

@gulujs/object-path 支持 TypeScript 吗?

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

@gulujs/object-path 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@gulujs/object-path 需要什么版本的 Node.js?

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

@gulujs/object-path 可以商用吗?

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

@gulujs/object-path 的下载量有多少?

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

@gulujs/object-path 还在维护吗?

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