Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Schema<T>

Base Schema Class

Type parameters

  • T

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

setDefault

  • 设置默认值，当待检验的参数为 undefined 或 null 时，将使用默认值为检查结果

    Parameters

    Returns Schema<T>

setRequired

  • setRequired(required: boolean): Schema<T>

  • 设置是否为必需的

    Parameters

    • required: boolean

      是否为必需的

    Returns Schema<T>

setValidate

validate

  • 检验参数是否合法 validate a parameter

    example
    const [ isValid, result ] = schema.validate({x: y})
if (isValid) {
  // 可使用已检验的参数结果 result 进行后续操作
  // do sth. with vadalited param - result
} else {
  console.error('Invalid Parameter...');
}

    Parameters

    Returns [boolean, ParameterType<T> | undefined]

    result - 检验后生成的结果

Static array

Static boolean

Static booleanArray

Static number

Static numberArray

Static object

Static objectArray

Static string

Static stringArray

Generated using TypeDoc