Class SchemaType

constructor

• new SchemaType(manager, fields, name?): SchemaType

• Parameters

  • manager: SchemaManager

  • fields: ISchemaTypeFields

  • Optional name: string

  Returns SchemaType

Readonly name

partial

• partial(): SchemaType

• 从当前Schema获取所有字段为可选的新Schema

  Returns SchemaType

pick

• pick(...fieldNames): SchemaType

• 从当前Schema获取仅包含指定字段的新Schema

  Parameters

  • Rest ...fieldNames: string[]

  Returns SchemaType

required

• required(): SchemaType

• 从当前Schema获取所有字段为必填的新Schema

  Returns SchemaType

swaggerValue

• swaggerValue(): {
      properties: Record<string, any>;
      required: string[];
  }

• 获取 schema swagger 的展开信息

  Returns {
      properties: Record<string, any>;
      required: string[];
  }

  ISchemaTypeFieldInfo

  • properties: Record<string, any>

  • required: string[]

  Memberof

  SchemaType

value

• value(input, isArray?): ISchemaCheckResult

• 检查Schema并返回值

  Parameters

  • input: any

  • Optional isArray: boolean

  Returns ISchemaCheckResult