@dipscope/type-manager/dist/types/type-options-base.d.ts

Transform JSON strings or plain objects into JS class instances.

import { CustomKey } from './custom-key';
import { CustomValue } from './custom-value';
import { Discriminator } from './discriminator';
import { Factory } from './factory';
import { InjectSorter } from './inject-sorter';
import { Injector } from './injector';
import { Logger } from './logger';
import { NamingConvention } from './naming-convention';
import { PropertySorter } from './property-sorter';
import { ReferenceHandler } from './reference-handler';
import { Serializer } from './serializer';
/**
 * Type options base interface.
 *
 * @type {TypeOptionsBase<TObject>}
 */
export declare type TypeOptionsBase<TObject> = {
    /**
     * Custom value map defined by developer.
     *
     * @type {Map<CustomKey<any>, CustomValue>}
     */
    customValueMap: Map<CustomKey<any>, CustomValue>;
    /**
     * Discriminator.
     *
     * @type {Discriminator}
     */
    discriminator: Discriminator;
    /**
     * Factory used to build instances of type.
     *
     * @type {Factory}
     */
    factory: Factory;
    /**
     * Injector used to resolve types.
     *
     * @type {Injector}
     */
    injector: Injector;
    /**
     * Logger instance with specified logger level.
     *
     * @type {Logger}
     */
    logger: Logger;
    /**
     * Naming convention.
     *
     * @type {NamingConvention}
     */
    namingConvention?: NamingConvention;
    /**
     * Preserve discriminator in object during serialization
     * and deserialization?
     *
     * @type {boolean}
     */
    preserveDiscriminator: boolean;
    /**
     * Reference handler.
     *
     * @type {ReferenceHandler}
     */
    referenceHandler: ReferenceHandler;
    /**
     * Serializer used to serialize and deserialize a type.
     *
     * @type {Serializer<TObject>}
     */
    serializer: Serializer<TObject>;
    /**
     * If set to true then null values are preserved. Otherwise they will be
     * treated as undefined.
     *
     * @type {boolean}
     */
    preserveNull: boolean;
    /**
     * Use default value assignment for undefined values?
     *
     * @type {boolean}
     */
    useDefaultValue: boolean;
    /**
     * Use implicit conversion when provided value can be converted
     * to the target one?
     *
     * @type {boolean}
     */
    useImplicitConversion: boolean;
    /**
     * Property sorter used to sort properties during serialization
     * and deserialization.
     *
     * @type {PropertySorter}
     */
    propertySorter?: PropertySorter;
    /**
     * Inject sorter used to sort injects during serialization
     * and deserialization.
     *
     * @type {InjectSorter}
     */
    injectSorter?: InjectSorter;
};
//# sourceMappingURL=type-options-base.d.ts.map