Class Transformer API - v3.0.1

Type aliases

InstanceToPlainReturn

InstanceToPlainReturn<V, T>: V extends undefined ? undefined : V extends boolean ? boolean : V extends number ? string : V extends null ? null : T

Type parameters

V
T

TypedConstructorType

TypedConstructorType: ObjectConstructor | ArrayConstructor | SetConstructor | MapConstructor | PromiseConstructor | StringConstructor | NumberConstructor | BooleanConstructor | FunctionConstructor | SymbolConstructor | RegExpConstructor | DateConstructor | JSON

TypedMetadataEnumImpl

TypedMetadataEnumImpl: TypedMetadataImpl & { enums: EnumArray }

TypedMetadataImpl

TypedMetadataImpl: (TypeMetadataScene & TypeMetadataToPlainOnly) | (TypeMetadataScene & TypeMetadataInstanceOnly) | (TypeMetadataTransform & TypeMetadataToPlainOnly) | (TypeMetadataTransform & TypeMetadataInstanceOnly)

Where

Where: Record<PropertyKey, any>

Variables

ARRAY

ARRAY: TypeMirror<any, any> = ...

DATE

DATE: TypeMirror<any, any> = ...

FUNCTION

FUNCTION: TypeMirror<any, any> = ...

MAP

MAP: TypeMirror<any, any> = ...

NUMBER

NUMBER: TypeMirror<any, any> = ...

PROMISE

PROMISE: TypeMirror<any, any> = ...

REGEXP

REGEXP: TypeMirror<any, any> = ...

SET

SET: TypeMirror<any, any> = ...

STRING

STRING: TypeMirror<any, any> = ...

SYMBOL

SYMBOL: TypeMirror<any, any> = ...

default

default: ClassTransformer = ...

Functions

Entity

Entity(option: EntityMetadataOption): ClassDecorator

- Defined in src/decorators/entity/index.ts:9
带参数实体装饰器

Parameters
- option: EntityMetadataOption
Returns ClassDecorator

Typed

Typed(type?: TypedConstructorType | ClassConstructor<any> | TypeMirror<any, any>, metadata?: TypedMetadataImpl): PropertyDecorator

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

Parameters
- Optional type: TypedConstructorType | ClassConstructor<any> | TypeMirror<any, any>
- Optional metadata: TypedMetadataImpl
Returns PropertyDecorator

TypedAny

TypedAny(metadata?: TypedMetadataImpl): PropertyDecorator

- Defined in src/decorators/typed-any/index.ts:11
Typed any decorator

Parameters
- Optional metadata: TypedMetadataImpl
Returns PropertyDecorator

TypedArray

TypedArray(type?: TypedConstructorType | ClassConstructor<any> | TypeMirror<any, any>, metadata?: TypedMetadataImpl): PropertyDecorator

- Defined in src/decorators/typed-array/index.ts:15
Typed array decorator

Parameters
- Optional type: TypedConstructorType | ClassConstructor<any> | TypeMirror<any, any>
- Optional metadata: TypedMetadataImpl
Returns PropertyDecorator

TypedEnum

TypedEnum(metadata: TypedMetadataEnumImpl): PropertyDecorator

- Defined in src/decorators/typed-enum/index.ts:10
Typed enum decorator

Parameters
- metadata: TypedMetadataEnumImpl
Returns PropertyDecorator

TypedMap

TypedMap(type?: TypedConstructorType | ClassConstructor<any> | TypeMirror<any, any>, metadata?: TypedMetadataImpl): PropertyDecorator

- Defined in src/decorators/typed-map/index.ts:15
Typed map decorator

Parameters
- Optional type: TypedConstructorType | ClassConstructor<any> | TypeMirror<any, any>
- Optional metadata: TypedMetadataImpl
Returns PropertyDecorator

TypedPromise

TypedPromise(type?: TypedConstructorType | ClassConstructor<any> | TypeMirror<any, any>, metadata?: TypedMetadataImpl): PropertyDecorator

- Defined in src/decorators/typed-promise/index.ts:15
Typed promise decorator

Parameters
- Optional type: TypedConstructorType | ClassConstructor<any> | TypeMirror<any, any>
- Optional metadata: TypedMetadataImpl
Returns PropertyDecorator

TypedSet

TypedSet(type?: TypedConstructorType | ClassConstructor<any> | TypeMirror<any, any>, metadata?: TypedMetadataImpl): PropertyDecorator

- Defined in src/decorators/typed-set/index.ts:15
Typed set decorator

Parameters
- Optional type: TypedConstructorType | ClassConstructor<any> | TypeMirror<any, any>
- Optional metadata: TypedMetadataImpl
Returns PropertyDecorator