Interface IValueTypeOptions

interface IValueTypeOptions {
    checker?: RegExp | ((v, p?) => boolean);
    description?: string;
    formatter?: ((v) => any);
    isBuiltin?: boolean;
    isDefaultFormat?: boolean;
    isParamsRequired?: boolean;
    nullable?: boolean;
    paramsChecker?: ((p) => boolean);
    parser?: ((v) => any);
    swaggerType?: SWAGGER_TYPE;
    tsType?: string;
}

Properties

checker? description? formatter? isBuiltin? isDefaultFormat? isParamsRequired? nullable? paramsChecker? parser? swaggerType? tsType?

Properties

Optional checker

checker?: RegExp | ((v, p?) => boolean)

② 检查方法

Type declaration

    • (v, p?): boolean

    • Parameters

      • v: any
      • Optional p: any

      Returns boolean

Optional description

description?: string

说明信息

Optional formatter

formatter?: ((v) => any)

③ 格式化方法

Type declaration

    • (v): any

    • ③ 格式化方法

      Parameters

      • v: any

      Returns any

Optional isBuiltin

isBuiltin?: boolean

是否为系统内置的类型

Optional isDefaultFormat

isDefaultFormat?: boolean

是否默认自动格式化

Optional isParamsRequired

isParamsRequired?: boolean

类型动态参数是否必须

Optional nullable

nullable?: boolean

能否为 null

Optional paramsChecker

paramsChecker?: ((p) => boolean)

类型动态参数检查器

Type declaration

    • (p): boolean

    • 类型动态参数检查器

      Parameters

      • p: any

      Returns boolean

Optional parser

parser?: ((v) => any)

① 解析方法

Type declaration

    • (v): any

    • ① 解析方法

      Parameters

      • v: any

      Returns any

Optional swaggerType

swaggerType?: SWAGGER_TYPE

对应的swagger 文档的类型

Optional tsType

tsType?: string

对应的TypeScript类型

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc