Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NumberArraySchema

NumberArraySchema 类，用于检验 number[] 类型的参数 默认要求不小于 0 的数组成的数组为合法值

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

setDefault

setMax

  • 设置最大数，大于此数的参数将认定为非法的

    example
    schema.setMax(0);

    Parameters

    • max: number

      最大数

    Returns NumberArraySchema

setMin

  • 设置最小数，小于此数的参数将认定为非法的

    example
    schema.setMin(0);

    Parameters

    • min: number

      最小数

    Returns NumberArraySchema

setRange

  • 设置可选的数，除此之外的参数将认定为非法的

    example
    schema.setRange([0, 1, 2]);

    Parameters

    • range: number[]

      可选的数

    Returns NumberArraySchema

setRequired

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<NumberArraySchemaType> | undefined]

    result - 检验后生成的结果

Static array

Static boolean

Static booleanArray

Static number

Static numberArray

Static object

Static objectArray

Static string

Static stringArray

Generated using TypeDoc