class-transformer/types/interfaces/class-transformer-options.interface.d.ts

Proper decorator-based transformation / serialization / deserialization of plain javascript objects to class constructors

import { TargetMap } from './target-map.interface';
/**
 * Options to be passed during transformation.
 */
export interface ClassTransformOptions {
    /**
     * Exclusion strategy. By default exposeAll is used, which means that it will expose all properties are transformed
     * by default.
     */
    strategy?: 'excludeAll' | 'exposeAll';
    /**
     * Indicates if extraneous properties should be excluded from the value when converting a plain value to a class.
     *
     * This option requires that each property on the target class has at least one `@Expose` or `@Exclude` decorator
     * assigned from this library.
     */
    excludeExtraneousValues?: boolean;
    /**
     * Only properties with given groups gonna be transformed.
     */
    groups?: string[];
    /**
     * Only properties with "since" > version < "until" gonna be transformed.
     */
    version?: number;
    /**
     * Excludes properties with the given prefixes. For example, if you mark your private properties with "_" and "__"
     * you can set this option's value to ["_", "__"] and all private properties will be skipped.
     * This works only for "exposeAll" strategy.
     */
    excludePrefixes?: string[];
    /**
     * If set to true then class transformer will ignore the effect of all @Expose and @Exclude decorators.
     * This option is useful if you want to kinda clone your object but do not apply decorators affects.
     *
     * __NOTE:__ You may still have to add the decorators to make other options work.
     */
    ignoreDecorators?: boolean;
    /**
     * Target maps allows to set a Types of the transforming object without using @Type decorator.
     * This is useful when you are transforming external classes, or if you already have type metadata for
     * objects and you don't want to set it up again.
     */
    targetMaps?: TargetMap[];
    /**
     * If set to true then class transformer will perform a circular check. (circular check is turned off by default)
     * This option is useful when you know for sure that your types might have a circular dependency.
     */
    enableCircularCheck?: boolean;
    /**
     * If set to true then class transformer will try to convert properties implicitly to their target type based on their typing information.
     *
     * DEFAULT: `false`
     */
    enableImplicitConversion?: boolean;
    /**
     * If set to true then class transformer will take default values for unprovided fields.
     * This is useful when you convert a plain object to a class and have an optional field with a default value.
     */
    exposeDefaultValues?: boolean;
    /**
     * When set to true, fields with `undefined` as value will be included in class to plain transformation. Otherwise
     * those fields will be omitted from the result.
     *
     * DEFAULT: `true`
     */
    exposeUnsetFields?: boolean;
}