UNPKG

3.19 kBTypeScriptView Raw
1
2import { ClassType } from "./ClassTransformer";
3import { ClassTransformOptions } from "./ClassTransformOptions";
4export { ClassTransformer } from "./ClassTransformer";
5export { ClassTransformOptions } from "./ClassTransformOptions";
6export * from "./metadata/ExposeExcludeOptions";
7export * from "./decorators";
8/**
9 * Converts class (constructor) object to plain (literal) object. Also works with arrays.
10 */
11export declare function classToPlain<T>(object: T, options?: ClassTransformOptions): Object;
12export declare function classToPlain<T>(object: T[], options?: ClassTransformOptions): Object[];
13/**
14 * Converts class (constructor) object to plain (literal) object.
15 * Uses given plain object as source object (it means fills given plain object with data from class object).
16 * Also works with arrays.
17 */
18export declare function classToPlainFromExist<T>(object: T, plainObject: Object, options?: ClassTransformOptions): Object;
19export declare function classToPlainFromExist<T>(object: T, plainObjects: Object[], options?: ClassTransformOptions): Object[];
20/**
21 * Converts plain (literal) object to class (constructor) object. Also works with arrays.
22 */
23export declare function plainToClass<T, V extends Array<any>>(cls: ClassType<T>, plain: V, options?: ClassTransformOptions): T[];
24export declare function plainToClass<T, V>(cls: ClassType<T>, plain: V, options?: ClassTransformOptions): T;
25/**
26 * Converts plain (literal) object to class (constructor) object.
27 * Uses given object as source object (it means fills given object with data from plain object).
28 * Also works with arrays.
29 */
30export declare function plainToClassFromExist<T, V extends Array<any>>(clsObject: T[], plain: V, options?: ClassTransformOptions): T[];
31export declare function plainToClassFromExist<T, V>(clsObject: T, plain: V, options?: ClassTransformOptions): T;
32/**
33 * Converts class (constructor) object to new class (constructor) object. Also works with arrays.
34 */
35export declare function classToClass<T>(object: T, options?: ClassTransformOptions): T;
36export declare function classToClass<T>(object: T[], options?: ClassTransformOptions): T[];
37/**
38 * Converts class (constructor) object to plain (literal) object.
39 * Uses given plain object as source object (it means fills given plain object with data from class object).
40 * Also works with arrays.
41 */
42export declare function classToClassFromExist<T>(object: T, fromObject: T, options?: ClassTransformOptions): T;
43export declare function classToClassFromExist<T>(object: T, fromObjects: T[], options?: ClassTransformOptions): T[];
44/**
45 * Serializes given object to a JSON string.
46 */
47export declare function serialize<T>(object: T, options?: ClassTransformOptions): string;
48export declare function serialize<T>(object: T[], options?: ClassTransformOptions): string;
49/**
50 * Deserializes given JSON string to a object of the given class.
51 */
52export declare function deserialize<T>(cls: ClassType<T>, json: string, options?: ClassTransformOptions): T;
53/**
54 * Deserializes given JSON string to an array of objects of the given class.
55 */
56export declare function deserializeArray<T>(cls: ClassType<T>, json: string, options?: ClassTransformOptions): T[];