ClassTransformer API

Index

Type Aliases

Functions

Type Aliases

NumberValidateTypes

NumberValidateTypes: "Integer" | "Float" | "range"

ObjectNumberValidateType

ObjectNumberValidateType: IntegerRule | FloatRule | RangeRule | EnumRule

Rule

StringValidateTypes

ValidateExceptionFields

ValidateExceptionFields: Record<PropertyKey, ValidateException[]>

Where

Where: Record<PropertyKey, any>

Functions

Typed

Typed<T>(options?: TypedMetadataOptions<T>): PropertyDecorator
Typed<T>(type?: TypeMirror<T, any> | ClassConstructor<T>, options?: Omit<TypedMetadataOptions<T>, "elementRules"> & TypedOps<T>): PropertyDecorator

- Defined in src/lib/decorators/typed/index.ts:40
Typed decorator

Type Parameters
- T extends object = any
Parameters
- Optional options: TypedMetadataOptions<T>
Returns PropertyDecorator
- Defined in src/lib/decorators/typed/index.ts:48
Typed decorator

Type Parameters
- T extends object = any
Parameters
- Optional type: TypeMirror<T, any> | ClassConstructor<T>
- Optional options: Omit<TypedMetadataOptions<T>, "elementRules"> & TypedOps<T>
Returns PropertyDecorator

TypedArray

TypedArray<T>(options?: Omit<TypedMetadataOptions<T[]>, "elementRules" | "rules"> & TypedArrayOps<T>): PropertyDecorator
TypedArray<T>(type?: TypeMirror<T, any> | ClassConstructor<T>, options?: Omit<TypedMetadataOptions<T[]>, "elementRules" | "rules"> & TypedArrayOps<T>): PropertyDecorator

- Defined in src/lib/decorators/typed-array/index.ts:43
TypedArray decorator

Type Parameters
- T extends object = any
Parameters
- Optional options: Omit<TypedMetadataOptions<T[]>, "elementRules" | "rules"> & TypedArrayOps<T>
Returns PropertyDecorator
- Defined in src/lib/decorators/typed-array/index.ts:52
TypedArray decorator

Type Parameters
- T extends object = any
Parameters
- Optional type: TypeMirror<T, any> | ClassConstructor<T>
- Optional options: Omit<TypedMetadataOptions<T[]>, "elementRules" | "rules"> & TypedArrayOps<T>
Returns PropertyDecorator

TypedMap

TypedMap<T>(options?: Omit<TypedMetadataOptions<Map<PropertyKey, T>>, "elementRules" | "rules"> & TypedMapOps<T>): PropertyDecorator
TypedMap<T>(type?: TypeMirror<T, any> | ClassConstructor<T>, options?: Omit<TypedMetadataOptions<Map<PropertyKey, T>>, "elementRules" | "rules"> & TypedMapOps<T>): PropertyDecorator

- Defined in src/lib/decorators/typed-map/index.ts:43
TypedMap decorator

Type Parameters
- T extends object = any
Parameters
- Optional options: Omit<TypedMetadataOptions<Map<PropertyKey, T>>, "elementRules" | "rules"> & TypedMapOps<T>
Returns PropertyDecorator
- Defined in src/lib/decorators/typed-map/index.ts:55
TypedMap decorator

Type Parameters
- T extends object = any
Parameters
- Optional type: TypeMirror<T, any> | ClassConstructor<T>
- Optional options: Omit<TypedMetadataOptions<Map<PropertyKey, T>>, "elementRules" | "rules"> & TypedMapOps<T>
Returns PropertyDecorator

TypedSet

TypedSet<T>(options?: Omit<TypedMetadataOptions<Set<T>>, "elementRules" | "rules"> & TypedSetOps<T>): PropertyDecorator
TypedSet<T>(type: ClassConstructor<T> | TypeMirror<T, any>, options?: Omit<TypedMetadataOptions<Set<T>>, "elementRules" | "rules"> & TypedSetOps<T>): PropertyDecorator

- Defined in src/lib/decorators/typed-set/index.ts:43
TypedSet decorator

Type Parameters
- T extends object = any
Parameters
- Optional options: Omit<TypedMetadataOptions<Set<T>>, "elementRules" | "rules"> & TypedSetOps<T>
Returns PropertyDecorator
- Defined in src/lib/decorators/typed-set/index.ts:52
TypedSet decorator

Type Parameters
- T extends object = any
Parameters
- type: ClassConstructor<T> | TypeMirror<T, any>
- Optional options: Omit<TypedMetadataOptions<Set<T>>, "elementRules" | "rules"> & TypedSetOps<T>
Returns PropertyDecorator

validate

validate(field: string, fieldValue: string, validators: IValidator[]): void

- Defined in src/lib/validate/index.ts:9
字段验证

Parameters
- field: string
  
  字段名称
- fieldValue: string
  
  字段值
- validators: IValidator[]
  
  验证器列表
Returns void

Index

Classes

Interfaces

Type Aliases

Functions

Type Aliases

NumberValidateTypes

ObjectNumberValidateType

Rule

StringValidateTypes

ValidateExceptionFields

Where

Functions

Typed

Type Parameters

T extends object = any

Parameters

Optional options: TypedMetadataOptions<T>

Returns PropertyDecorator

Type Parameters

T extends object = any

Parameters

Optional type: TypeMirror<T, any> | ClassConstructor<T>

Optional options: Omit<TypedMetadataOptions<T>, "elementRules"> & TypedOps<T>

Returns PropertyDecorator

TypedArray

Type Parameters

T extends object = any

Parameters

Optional options: Omit<TypedMetadataOptions<T[]>, "elementRules" | "rules"> & TypedArrayOps<T>

Returns PropertyDecorator

Type Parameters

T extends object = any

Parameters

Optional type: TypeMirror<T, any> | ClassConstructor<T>

Optional options: Omit<TypedMetadataOptions<T[]>, "elementRules" | "rules"> & TypedArrayOps<T>

Returns PropertyDecorator

TypedMap

Type Parameters

T extends object = any

Parameters

Optional options: Omit<TypedMetadataOptions<Map<PropertyKey, T>>, "elementRules" | "rules"> & TypedMapOps<T>

Returns PropertyDecorator

Type Parameters

T extends object = any

Parameters

Optional type: TypeMirror<T, any> | ClassConstructor<T>

Optional options: Omit<TypedMetadataOptions<Map<PropertyKey, T>>, "elementRules" | "rules"> & TypedMapOps<T>

Returns PropertyDecorator

TypedSet

Type Parameters

T extends object = any

Parameters

Optional options: Omit<TypedMetadataOptions<Set<T>>, "elementRules" | "rules"> & TypedSetOps<T>

Returns PropertyDecorator

Type Parameters

T extends object = any

Parameters

type: ClassConstructor<T> | TypeMirror<T, any>

Optional options: Omit<TypedMetadataOptions<Set<T>>, "elementRules" | "rules"> & TypedSetOps<T>

Returns PropertyDecorator

validate

Parameters

field: string

fieldValue: string

validators: IValidator[]

Returns void