zoxy 中文文档教程

Question

围绕 Zod 的小型类型安全对象代理，可帮助您在加载数据后保持安全。

因为在加载复杂结构后对其进行深入修改和验证可能有点冗长。

如果加载后不需要修改数据，则可能不需要 zoxy！

---

Installation

pnpm add zod zoxy

Basic usage (live demo)

import { z } from 'zod';
import { zoxy } from 'zoxy';

const User = z.object({
  username: z.string().min(4),
  email: z.string().email().optional(),
  phone: z.object({
    home: z.string().min(10).max(42).optional(),
    work: z.string().min(10).max(42).optional(),
  }),
  foo: z.object({ bar: z.object({ baz: z.string().max(3).optional() }).optional() }).optional(),
});

const user = zoxy(User, { username: 'anonymous', phone: {} });

// Pass
user.username = 'nyan';
user.email = undefined;
user.phone.home = '555 042 42 42';
user.phone = { home: '555 042 42 42', work: '555 024 24 24' };

// Fail
user.email = 'xxx'; // throw 'Invalid email'
user.phone = { home: 'xxx' }; // throw 'String must contain at least 10 character(s)'

Ensure default value

In the example below the模式具有三个级别，这些级别都是可选的，如果您想定义最后一个级别，它可能会非常冗长。 Zoxy 提供了一个解决方案，带有一个小助手，可确保设置默认值。只需在所需值前加上“$”符号前缀，您就可以获得一个允许您设置默认值的方法。

const Data = z.object({
  foo: z
    .object({
      bar: z
        .object({
          baz: z.string().max(3).optional(),
        })
        .optional(),
    })
    .optional(),
});

const data = zoxy(Data, {});

// Get `data.foo.bar.baz` if defined or set default value where needed.
const baz = data.$foo({}).$bar({}).$baz('baz'); // 'baz'

上述行将执行以下操作：

• 如果 data.foo 未定义，则将其设置为 {}
• 如果 data.foo.bar 未定义，则将其设置为 {}
• 如果 data.foo.bar.baz 未定义，将其设置为 'baz'
• 返回 data.foo.bar.baz

请注意，如果之前已经初始化过，则返回值可能与默认值不同。

设置深度可选属性

如果要深度分配新值，则必须使用以下语法。

// Set default value on `foo.bar` where needed and set `foo.bar.baz` to 'buzz'.
data.$foo({}).$bar({}).baz = 'buzz';

console.log(data.foo?.bar?.baz); // 'buzz'

签名

function zoxy(schema: ZodObject, data: Data, options?: ZoxyOptions): Zoxy;

选项

type ZoxyOptions = {
  prefix: string; // default '$'
};

---

使用 @skarab/skaffold 搭建的