关于javascript:TS-分享一个类型支持非常完善的-object-path-package

35次阅读

共计 1002 个字符,预计需要花费 3 分钟才能阅读完成。

之前用过波及到 object path 的一些 package,然而发现这些 packages 的类型反对不是特地欠缺,比方 lodash, react-hook-form, formik, mongodb client 等。

这些 packages,或多或少存在的几个问题是:

  • 没有类型束缚,不能提供代码主动实现;
  • 生成的 path 不是规范的,大部分只反对 ‘a.b.c’ 这种,这种 path 有一些毛病,与其余 package 不对立(例如 yup),不能辨别 object/array,大部分都是判断如果是数字就当成数组解决,然而理论可能是 number key 的 object;
  • 不能通过 path 反推出对应的类型。

因为我在写 react-happy-form 这个开源我的项目的时候,对 object path 这块需要比拟高,所以就本人独自写了 object-standard-path 这个 package:

  • 提供了十分欠缺的类型反对(包含对一些非凡类型 any, Map 等的解决);
  • 生成的是规范的 path;
  • 反对应用 path 对类型进行反推。

应用起来也非常简单,没有任何依赖,1k 不到的包体积,如果有需要的话,大家能够试试 :)

Repo 地址:https://github.com/react-earth/object-standard-path

能够的话,能够小点个 star,每个 star 都是我当前继续更新的能源,感激!🌟

import {Path, PathValue, pathGet, pathSet} from 'object-standard-path';

type Test = {
  value: string;
  array: {value: string;}[];};

type TestPath = Path<Test>;
// result: "value" | "array" | `array[${number}]` | `array[${number}].value`

type TestPathValue = PathValue<Test, 'array[0]'>;
// result: {value: string}

const object = {
  array: [
    {value: 1,},
  ],
};

const result = pathGet(object, 'array[0].value');
// result: 1

pathSet(object, 'array[0].value', 2);
// result: {array: [{ value: 2}] }

正文完
 0