Skip to main content
Module

x/class_transformer/mod.ts>ClassTransformer

Deno port of class-transformer
tnifey/class-transformer
Latest
class ClassTransformer
Re-export
import { ClassTransformer } from "https://deno.land/x/class_transformer@v0.2.3-beta.1/mod.ts";

Methods

classToClass<T>(object: T, options?: ClassTransformOptions): T

Converts class (constructor) object to new class (constructor) object. Also works with arrays.

classToClass<T>(object: T[], options?: ClassTransformOptions): T[]
classToClassFromExist<T>(
object: T,
fromObject: T,
): T

Converts class (constructor) object to plain (literal) object. Uses given plain object as source object (it means fills given plain object with data from class object). Also works with arrays.

classToClassFromExist<T>(
object: T,
fromObjects: T[],
): T[]
classToPlain<T extends Object>(object: T, options?: ClassTransformOptions): Object

Converts class (constructor) object to plain (literal) object. Also works with arrays.

classToPlain<T extends Object>(object: T[], options?: ClassTransformOptions): Object[]
classToPlainFromExist<T extends Object, P>(
object: T,
plainObject: P,
): T

Converts class (constructor) object to plain (literal) object. Uses given plain object as source object (it means fills given plain object with data from class object). Also works with arrays.

classToPlainFromExist<T extends Object, P>(
object: T,
plainObjects: P[],
): T[]
deserialize<T>(
cls: ClassType<T>,
json: string,
): T

Deserializes given JSON string to a object of the given class.

deserializeArray<T>(
cls: ClassType<T>,
json: string,
): T[]

Deserializes given JSON string to an array of objects of the given class.

plainToClass<T extends Object, V extends Array<any>>(
cls: ClassType<T>,
plain: V,
): T[]

Converts plain (literal) object to class (constructor) object. Also works with arrays.

plainToClass<T extends Object, V>(
cls: ClassType<T>,
plain: V,
): T
plainToClassFromExist<T extends Object, V extends Array<any>>(
clsObject: T,
plain: V,
): T

Converts plain (literal) object to class (constructor) object. Uses given object as source object (it means fills given object with data from plain object). Also works with arrays.

plainToClassFromExist<T extends Object, V>(
clsObject: T,
plain: V,
): T[]
serialize<T>(object: T, options?: ClassTransformOptions): string

Serializes given object to a JSON string.

serialize<T>(object: T[], options?: ClassTransformOptions): string