Class ClassTransformer

Hierarchy

ClassTransformer

Index

Constructors

constructor

Properties

plugins

Methods

Constructors

constructor

new ClassTransformer(option?: ClassTransformerOption): ClassTransformer

- Defined in src/lib/class-transformer/index.ts:44
构造函数

Parameters
- Optional option: ClassTransformerOption
Returns ClassTransformer

Properties

Private plugins

plugins: Map<TypedConstructorType | ClassConstructor<any>, PluginConstructor> = ...

Methods

Private getArgumentsList

getArgumentsList<T>(targetType: ClassConstructor<T>): any[]

- Defined in src/lib/class-transformer/index.ts:68
获取参数列表

Type parameters
- T: {}
Parameters
- targetType: ClassConstructor<T>
Returns any[]

instanceToPlain

instanceToPlain<V, T>(value: V): InstanceToPlainReturn<V, T>

- Defined in src/lib/class-transformer/index.ts:231
instance to plain

Type parameters
- V: object = object
- T = any
Parameters
- value: V
Returns InstanceToPlainReturn<V, T>

newInstance

newInstance<T>(targetType: ClassConstructor<T>): T

- Defined in src/lib/class-transformer/index.ts:92
创建实例

Type parameters
- T: {}
Parameters
- targetType: ClassConstructor<T>
Returns T

plainToInstance

plainToInstance<T, V>(type: ClassConstructor<T>, value: V, option?: PlainToInstanceOptions): T

- Defined in src/lib/class-transformer/index.ts:146
transform to instance

Type parameters
- T: {} = {}
- V: Partial<Record<keyof T, any>> & {} = any
Parameters
- type: ClassConstructor<T>
- value: V
- option: PlainToInstanceOptions = {}
Returns T

plainToInstanceList

plainToInstanceList<T, V>(type: ClassConstructor<T>, value: V, option?: PlainToInstanceOptions): T

- Defined in src/lib/class-transformer/index.ts:163
transform to instance list

Type parameters
- T: {} = {}
- V: (Partial<Record<keyof T, any>> & {})[] = any[]
Parameters
- type: ClassConstructor<T>
- value: V
- option: PlainToInstanceOptions = {}
Returns T

plainToInstanceMap

plainToInstanceMap<T, V>(type: ClassConstructor<T>, value: V, option?: PlainToInstanceOptions): T

- Defined in src/lib/class-transformer/index.ts:211
transform to instance map

Type parameters
- T: {} = {}
- V: Partial<Record<keyof T, any>> & {} = any
Parameters
- type: ClassConstructor<T>
- value: V
- option: PlainToInstanceOptions = {}
Returns T

plainToInstanceSet

plainToInstanceSet<T, V>(type: ClassConstructor<T>, value: V, option?: PlainToInstanceOptions): T

- Defined in src/lib/class-transformer/index.ts:187
transform to instance set

Type parameters
- T: {} = {}
- V: (Partial<Record<keyof T, any>> & {})[] = any[]
Parameters
- type: ClassConstructor<T>
- value: V
- option: PlainToInstanceOptions = {}
Returns T

toPlain

toPlain<T>(type: TypedConstructorType | ClassConstructor<any>, metadata: undefined | TypedMetadataImpl | TypedMetadataEnumImpl, value: any): undefined | T

- Defined in src/lib/class-transformer/index.ts:129
toPlain

Type parameters
- T = any
Parameters
- type: TypedConstructorType | ClassConstructor<any>
- metadata: undefined | TypedMetadataImpl | TypedMetadataEnumImpl
- value: any
Returns undefined | T

transform

transform<T, V>(type: TypedConstructorType | ClassConstructor<T>, elementType: undefined | TypeMirror<any, any>, metadata: undefined | TypedMetadataImpl | TypedMetadataEnumImpl, value: V, option?: PlainToInstanceOptions): any

- Defined in src/lib/class-transformer/index.ts:104
transform

Type parameters
- T: {}
- V = any
Parameters
- type: TypedConstructorType | ClassConstructor<T>
- elementType: undefined | TypeMirror<any, any>
- metadata: undefined | TypedMetadataImpl | TypedMetadataEnumImpl
- value: V
- option: PlainToInstanceOptions = {}
Returns any

use

use(...plugin: PluginConstructor[]): void

- Defined in src/lib/class-transformer/index.ts:247
Use plugins

Parameters
- Rest ...plugin: PluginConstructor[]
Returns void