Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ObjectType

对象描述类

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected validators

validators: Validator[] = []

自定义验证器数组

Accessors

nullable

  • get nullable(): this

Static any

Static boolean

Static date

Static function

Static number

Static regExp

Static string

Methods

baseValidate

  • baseValidate(obj: any, object?: any, key?: string, path?: string[]): Promise<ErrorMessage[]>

baseValidateSync

  • baseValidateSync(obj: any, object?: any, key?: string, path?: string[]): ErrorMessage[]

check

  • check(value: any, object?: any, key?: string, path?: string[]): Promise<ErrorMessage[]>

  • 检查对象，并返回错误信息，异步

    Parameters

    • value: any

      被验证的值

    • Optional object: any

      该值来自的对象

    • Optional key: string

      该值在对象上的属性

    • path: string[] = []

      该值的路径

    Returns Promise<ErrorMessage[]>

checkSync

  • checkSync(value: any, object?: any, key?: string, path?: string[]): ErrorMessage[]

  • 检查对象，并返回错误信息，同步

    Parameters

    • value: any

      被验证的值

    • Optional object: any

      该值来自的对象

    • Optional key: string

      该值在对象上的属性

    • path: string[] = []

      该值的路径

    Returns ErrorMessage[]

copy

custom

getAsyncChecker

  • getAsyncChecker(): (value: any, object?: any, key?: string, path?: string[]) => Promise<ErrorMessage[]>

  • 返回异步验证器，会返回错误信息

    Returns (value: any, object?: any, key?: string, path?: string[]) => Promise<ErrorMessage[]>

      • (value: any, object?: any, key?: string, path?: string[]): Promise<ErrorMessage[]>

      • 检查对象，并返回错误信息，异步

        Parameters

        • value: any

          被验证的值

        • Optional object: any

          该值来自的对象

        • Optional key: string

          该值在对象上的属性

        • path: string[] = []

          该值的路径

        Returns Promise<ErrorMessage[]>

getAsyncValidator

  • getAsyncValidator(): (value: any) => Promise<void>

  • 返回异步验证器，会抛出错误信息

    Returns (value: any) => Promise<void>

      • (value: any): Promise<void>

      • 检查对象，如有错误信息通过异常抛出，异步

        Parameters

        • value: any

          被验证的值

        Returns Promise<void>

getSyncChecker

  • getSyncChecker(): (value: any, object?: any, key?: string, path?: string[]) => ErrorMessage[]

  • 返回同步验证器，会返回错误信息

    Returns (value: any, object?: any, key?: string, path?: string[]) => ErrorMessage[]

      • (value: any, object?: any, key?: string, path?: string[]): ErrorMessage[]

      • 检查对象，并返回错误信息，同步

        Parameters

        • value: any

          被验证的值

        • Optional object: any

          该值来自的对象

        • Optional key: string

          该值在对象上的属性

        • path: string[] = []

          该值的路径

        Returns ErrorMessage[]

getSyncValidator

  • getSyncValidator(): (value: any) => void

  • 返回同步验证器，会抛出错误信息

    Returns (value: any) => void

      • (value: any): void

      • 检查对象，如有错误信息通过异常抛出，同步

        Parameters

        • value: any

          被验证的值

        Returns void

type

validate

  • validate(value: any): Promise<void>

  • 检查对象，如有错误信息通过异常抛出，异步

    Parameters

    • value: any

      被验证的值

    Returns Promise<void>

validateSync

  • validateSync(value: any): void

  • 检查对象，如有错误信息通过异常抛出，同步

    Parameters

    • value: any

      被验证的值

    Returns void

Static array

  • 生成数组描述类

    Parameters

    • Optional types: Type[]

      数组元素类型描述，只需满足一个就能通过检查

    Returns ArrayType

Static enum

Static object

Generated using TypeDoc