Function useVerify

  • 创建一个验证器,用于对对象的属性进行验证

    Type Parameters

    • T extends object

      需要验证的对象的类型

    Parameters

    • obj: T

      需要验证的对象

    Returns {
        clear: ((...keys) => void);
        clearValidate: ((...keys) => void);
        unuse: (<K>(...keys) => ((...middlewares) => void));
        use: (<K>(...keys) => ((...middlewares) => void));
        validate: ((...keys) => Promise<void>);
        verify: ((key) => UnwrapNestedRefs<{
            [K in string | number | symbol]?: string
        }>[keyof T]);
    }

    验证器对象,包含验证方法和管理中间件的方法

    • clear: ((...keys) => void)
        • (...keys): void
        • 清除指定属性上的中间件

          Parameters

          • Rest ...keys: (keyof T)[]

            需要清除中间件的属性名,不传则默认清除所有属性上的中间件

          Returns void

    • clearValidate: ((...keys) => void)
        • (...keys): void
        • 清除指定属性上的验证结果

          Parameters

          • Rest ...keys: (keyof T)[]

            需要清除验证结果的属性名,不传则默认清除所有属性的验证结果

          Returns void

    • unuse: (<K>(...keys) => ((...middlewares) => void))
        • <K>(...keys): ((...middlewares) => void)
        • 从映射表中移除中间件

          Type Parameters

          • K extends string | number | symbol

          Parameters

          • Rest ...keys: K[]

            需要移除中间件的属性名,不传则默认移除所有属性上的中间件

          Returns ((...middlewares) => void)

            • (...middlewares): void
            • Parameters

              • Rest ...middlewares: Middleware<{
                    key: K;
                    value: T[K];
                }>[]

              Returns void

    • use: (<K>(...keys) => ((...middlewares) => void))
        • <K>(...keys): ((...middlewares) => void)
        • 添加中间件到映射表中

          Type Parameters

          • K extends string | number | symbol

          Parameters

          • Rest ...keys: K[]

            需要添加中间件的属性名,不传则默认添加到所有属性上

          Returns ((...middlewares) => void)

            • (...middlewares): void
            • Parameters

              • Rest ...middlewares: Middleware<{
                    key: K;
                    value: T[K];
                }>[]

              Returns void

    • validate: ((...keys) => Promise<void>)
        • (...keys): Promise<void>
        • 对指定属性进行验证

          Parameters

          • Rest ...keys: (keyof T)[]

            需要验证的属性名,不传则默认验证所有属性

          Returns Promise<void>

          Throws

          • 如果有任何属性验证失败,则抛出错误
    • verify: ((key) => UnwrapNestedRefs<{
          [K in string | number | symbol]?: string
      }>[keyof T])
        • (key): UnwrapNestedRefs<{
              [K in string | number | symbol]?: string
          }>[keyof T]
        • 获取指定属性的验证结果

          Parameters

          • key: keyof T

            需要获取验证结果的属性名

          Returns UnwrapNestedRefs<{
              [K in string | number | symbol]?: string
          }>[keyof T]

          • 验证结果

Generated using TypeDoc