Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ObjectSchema

ObjectSchema 类，用于检验 Record<string, any> 即 object 类型的参数

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

merge

  • 合并其他 ObjectSchema 中设置的 schemas

    example
    const aSchema = Schema.object({
  a: Schema.string();
});
const abSchema = Schema.object({
  b: Schema.string();
}).merge(aSchema);

    Parameters

    Returns ObjectSchema

setDefault

setFieldSchemas

  • 对每个 field 配置一个 Schema

    example
    schema.setFieldSchemas({
  a: Schema.number(),
  b: Schema.string().setDefault(''),
  c: Schema.boolean(),
  d: Schema.object().setSchemas({
    da: Schema.numberArray().setDefault([1]),
    db: Schema.stringArray(),
    dc: Schema.booleanArray(),
  }),
});

    Parameters

    Returns ObjectSchema

setRequired

setValidate

  • setValidate(validate: (param: Record<string, any>) => boolean): ObjectSchema

  • Parameters

    • validate: (param: Record<string, any>) => boolean
        • (param: Record<string, any>): boolean

        • Parameters

          • param: Record<string, any>

          Returns boolean

    Returns ObjectSchema

validate

  • validate(param: Record<string, any>): [boolean, Record<string, any> | undefined]

  • Parameters

    • param: Record<string, any>

    Returns [boolean, Record<string, any> | undefined]

Static array

Static boolean

Static booleanArray

Static number

Static numberArray

Static object

Static objectArray

Static string

Static stringArray

Generated using TypeDoc