@dipscope/type-manager 5.0.0-beta.1 → 5.0.0

package/property-metadata.d.ts

@@ -1,196 +1,309 @@
-import { Alias } from './alias';
-import { CustomData } from './custom-data';
-import { GenericArgument } from './generic-argument';
-import { GenericMetadata } from './generic-metadata';
-import { Metadata } from './metadata';
-import { NamingConvention } from './naming-convention';
-import { PropertyName } from './property-name';
-import { PropertyOptions } from './property-options';
-import { ReferenceHandler } from './reference-handler';
-import { Serializer } from './serializer';
-import { TypeArgument } from './type-argument';
-import { TypeFn } from './type-fn';
-import { TypeMetadata } from './type-metadata';
-/**
- * Main class used to describe a certain property.
- *
- * @type {PropertyMetadata<TDeclaringType, TType>}
- */
-export declare class PropertyMetadata<TDeclaringType, TType> extends Metadata {
-    /**
-     * Type metadata to which property metadata belongs to.
-     *
-     * @type {TypeMetadata<TDeclaringType>}
-     */
-    readonly declaringTypeMetadata: TypeMetadata<TDeclaringType>;
-    /**
-     * Type function defined using reflect metadata.
-     *
-     * Used as a fallback when type argument is not defined.
-     *
-     * @type {TypeFn<TType>}
-     */
-    readonly reflectTypeFn: TypeFn<TType>;
-    /**
-     * Property name as declared in type.
-     *
-     * @type {PropertyName}
-     */
-    readonly propertyName: PropertyName;
-    /**
-     * Property options.
-     *
-     * @type {PropertyOptions<TType>}
-     */
-    readonly propertyOptions: PropertyOptions<TType>;
-    /**
-     * Constructor.
-     *
-     * @param {TypeMetadata<TDeclaringType>} declaringTypeMetadata Type metadata to which property metadata belongs to.
-     * @param {PropertyName} propertyName Property name.
-     * @param {PropertyOptions<TType>} propertyOptions Property options.
-     */
-    constructor(declaringTypeMetadata: TypeMetadata<TDeclaringType>, propertyName: PropertyName, propertyOptions: PropertyOptions<TType>);
-    /**
-     * Gets alias.
-     *
-     * @returns {Alias|undefined} Alias or undefined.
-     */
-    get alias(): Alias | undefined;
-    /**
-     * Gets custom data.
-     *
-     * @returns {CustomData} Custom data.
-     */
-    get customData(): CustomData;
-    /**
-     * Gets serialized null value.
-     *
-     * @returns {any|undefined} Resolved serialized null value or undefined.
-     */
-    get serializedNullValue(): any | undefined;
-    /**
-     * Gets serialized default value.
-     *
-     * @returns {any|undefined} Resolved serialized default value or undefined.
-     */
-    get serializedDefaultValue(): any | undefined;
-    /**
-     * Gets deserialized null value.
-     *
-     * @returns {any|undefined} Resolved deserialized null value or undefined.
-     */
-    get deserializedNullValue(): any | undefined;
-    /**
-     * Gets deserialized default value.
-     *
-     * @returns {any|undefined} Resolved deserialized default value or undefined.
-     */
-    get deserializedDefaultValue(): any | undefined;
-    /**
-     * Gets serialized property name.
-     *
-     * @returns {string} Serialized property name.
-     */
-    get serializedPropertyName(): string;
-    /**
-     * Gets deserialized property name.
-     *
-     * @returns {string} Deserialized property name.
-     */
-    get deserializedPropertyName(): string;
-    /**
-     * Gets deserializable value.
-     *
-     * @returns {boolean|undefined} Deserializable indicator or undefined.
-     */
-    get deserializable(): boolean | undefined;
-    /**
-     * Gets generic arguments.
-     *
-     * @returns {Array<GenericArgument<any>>|undefined} Generic arguments or undefined.
-     */
-    get genericArguments(): Array<GenericArgument<any>> | undefined;
-    /**
-     * Gets generic metadatas.
-     *
-     * @returns {Array<GenericMetadata<any>>|undefined} Generic metadatas.
-     */
-    get genericMetadatas(): Array<GenericMetadata<any>> | undefined;
-    /**
-     * Gets naming convention.
-     *
-     * @returns {NamingConvention|undefined} Naming convention or undefined.
-     */
-    get namingConvention(): NamingConvention | undefined;
-    /**
-     * Gets reference handler.
-     *
-     * @returns {ReferenceHandler} Reference handler.
-     */
-    get referenceHandler(): ReferenceHandler;
-    /**
-     * Gets serializable value.
-     *
-     * @returns {boolean|undefined} Serializable indicator or undefined.
-     */
-    get serializable(): boolean | undefined;
-    /**
-     * Checks if serialization configured.
-     *
-     * @returns {boolean} True when serialization configured. False otherwise.
-     */
-    get serializationConfigured(): boolean;
-    /**
-     * Gets serializer.
-     *
-     * @returns {Serializer<TType>} Serializer.
-     */
-    get serializer(): Serializer<TType>;
-    /**
-     * Gets type argument.
-     *
-     * @returns {TypeArgument|undefined} Type argument or undefined.
-     */
-    get typeArgument(): TypeArgument<TType> | undefined;
-    /**
-     * Gets type metadata.
-     *
-     * @returns {TypeMetadata<TType>} Type metadata.
-     */
-    get typeMetadata(): TypeMetadata<TType>;
-    /**
-     * Gets indicator if null value should be preserved.
-     *
-     * @returns {boolean} True when null value should be preserved. False otherwise.
-     */
-    get preserveNull(): boolean;
-    /**
-     * Gets indicator if default value should be used.
-     *
-     * @returns {boolean} Use default value indicator.
-     */
-    get useDefaultValue(): boolean;
-    /**
-     * Gets indicator if implicit conversion should be used.
-     *
-     * @returns {boolean} Use implicit conversion indicator.
-     */
-    get useImplicitConversion(): boolean;
-    /**
-     * Configures custom data.
-     *
-     * @param {CustomData} customData Custom data.
-     *
-     * @returns {PropertyMetadata<TDeclaringType, TType>} Instance of property metadata.
-     */
-    private configureCustomData;
-    /**
-     * Configures property metadata based on provided options.
-     *
-     * @param {PropertyOptions<TType>} propertyOptions Property options.
-     *
-     * @returns {PropertyMetadata<TDeclaringType, TType>} Instance of property metadata.
-     */
-    configure(propertyOptions: PropertyOptions<TType>): PropertyMetadata<TDeclaringType, TType>;
-}
+import { Alias } from './alias';
+import { CustomData } from './custom-data';
+import { DefaultValue } from './default-value';
+import { GenericArgument } from './generic-argument';
+import { GenericMetadata } from './generic-metadata';
+import { Metadata } from './metadata';
+import { NamingConvention } from './naming-convention';
+import { PropertyName } from './property-name';
+import { PropertyOptions } from './property-options';
+import { ReferenceHandler } from './reference-handler';
+import { Serializer } from './serializer';
+import { TypeArgument } from './type-argument';
+import { TypeFn } from './type-fn';
+import { TypeMetadata } from './type-metadata';
+/**
+ * Main class used to describe a certain property.
+ *
+ * @type {PropertyMetadata<TDeclaringType, TType>}
+ */
+export declare class PropertyMetadata<TDeclaringType, TType> extends Metadata {
+    /**
+     * Type metadata to which property metadata belongs to.
+     *
+     * @type {TypeMetadata<TDeclaringType>}
+     */
+    readonly declaringTypeMetadata: TypeMetadata<TDeclaringType>;
+    /**
+     * Type function defined using reflect metadata.
+     *
+     * Used as a fallback when type argument is not defined.
+     *
+     * @type {TypeFn<TType>}
+     */
+    readonly reflectTypeFn: TypeFn<TType>;
+    /**
+     * Property name as declared in type.
+     *
+     * @type {PropertyName}
+     */
+    readonly propertyName: PropertyName;
+    /**
+     * Property options.
+     *
+     * @type {PropertyOptions<TType>}
+     */
+    readonly propertyOptions: PropertyOptions<TType>;
+    /**
+     * Constructor.
+     *
+     * @param {TypeMetadata<TDeclaringType>} declaringTypeMetadata Type metadata to which property metadata belongs to.
+     * @param {PropertyName} propertyName Property name.
+     * @param {PropertyOptions<TType>} propertyOptions Property options.
+     */
+    constructor(declaringTypeMetadata: TypeMetadata<TDeclaringType>, propertyName: PropertyName, propertyOptions: PropertyOptions<TType>);
+    /**
+     * Gets alias.
+     *
+     * @returns {Alias|undefined} Alias or undefined.
+     */
+    get alias(): Alias | undefined;
+    /**
+     * Gets custom data.
+     *
+     * @returns {CustomData} Custom data.
+     */
+    get customData(): CustomData;
+    /**
+     * Gets serialized null value.
+     *
+     * @returns {any|undefined} Resolved serialized null value or undefined.
+     */
+    get serializedNullValue(): any | undefined;
+    /**
+     * Gets serialized default value.
+     *
+     * @returns {any|undefined} Resolved serialized default value or undefined.
+     */
+    get serializedDefaultValue(): any | undefined;
+    /**
+     * Gets deserialized null value.
+     *
+     * @returns {any|undefined} Resolved deserialized null value or undefined.
+     */
+    get deserializedNullValue(): any | undefined;
+    /**
+     * Gets deserialized default value.
+     *
+     * @returns {any|undefined} Resolved deserialized default value or undefined.
+     */
+    get deserializedDefaultValue(): any | undefined;
+    /**
+     * Gets serialized property name.
+     *
+     * @returns {string} Serialized property name.
+     */
+    get serializedPropertyName(): string;
+    /**
+     * Gets deserialized property name.
+     *
+     * @returns {string} Deserialized property name.
+     */
+    get deserializedPropertyName(): string;
+    /**
+     * Gets deserializable value.
+     *
+     * @returns {boolean|undefined} Deserializable indicator or undefined.
+     */
+    get deserializable(): boolean | undefined;
+    /**
+     * Gets generic arguments.
+     *
+     * @returns {Array<GenericArgument<any>>|undefined} Generic arguments or undefined.
+     */
+    get genericArguments(): Array<GenericArgument<any>> | undefined;
+    /**
+     * Gets generic metadatas.
+     *
+     * @returns {Array<GenericMetadata<any>>|undefined} Generic metadatas.
+     */
+    get genericMetadatas(): Array<GenericMetadata<any>> | undefined;
+    /**
+     * Gets naming convention.
+     *
+     * @returns {NamingConvention|undefined} Naming convention or undefined.
+     */
+    get namingConvention(): NamingConvention | undefined;
+    /**
+     * Gets reference handler.
+     *
+     * @returns {ReferenceHandler} Reference handler.
+     */
+    get referenceHandler(): ReferenceHandler;
+    /**
+     * Gets serializable value.
+     *
+     * @returns {boolean|undefined} Serializable indicator or undefined.
+     */
+    get serializable(): boolean | undefined;
+    /**
+     * Checks if serialization configured.
+     *
+     * @returns {boolean} True when serialization configured. False otherwise.
+     */
+    get serializationConfigured(): boolean;
+    /**
+     * Gets serializer.
+     *
+     * @returns {Serializer<TType>} Serializer.
+     */
+    get serializer(): Serializer<TType>;
+    /**
+     * Gets type argument.
+     *
+     * @returns {TypeArgument|undefined} Type argument or undefined.
+     */
+    get typeArgument(): TypeArgument<TType> | undefined;
+    /**
+     * Gets type metadata.
+     *
+     * @returns {TypeMetadata<TType>} Type metadata.
+     */
+    get typeMetadata(): TypeMetadata<TType>;
+    /**
+     * Gets indicator if null value should be preserved.
+     *
+     * @returns {boolean} True when null value should be preserved. False otherwise.
+     */
+    get preserveNull(): boolean;
+    /**
+     * Gets indicator if default value should be used.
+     *
+     * @returns {boolean} Use default value indicator.
+     */
+    get useDefaultValue(): boolean;
+    /**
+     * Gets indicator if implicit conversion should be used.
+     *
+     * @returns {boolean} Use implicit conversion indicator.
+     */
+    get useImplicitConversion(): boolean;
+    /**
+     * Configures alias.
+     *
+     * @param {Alias} alias Alias.
+     *
+     * @returns {PropertyMetadata<TDeclaringType, TType>} Current instance of property metadata.
+     */
+    configureAlias(alias: Alias): PropertyMetadata<TDeclaringType, TType>;
+    /**
+     * Configures custom data.
+     *
+     * @param {CustomData} customData Custom data.
+     *
+     * @returns {PropertyMetadata<TDeclaringType, TType>} Current instance of property metadata.
+     */
+    configureCustomData(customData: CustomData): PropertyMetadata<TDeclaringType, TType>;
+    /**
+     * Configures default value.
+     *
+     * @param {DefaultValue} defaultValue Default value.
+     *
+     * @returns {PropertyMetadata<TDeclaringType, TType>} Current instance of property metadata.
+     */
+    configureDefaultValue(defaultValue: DefaultValue): PropertyMetadata<TDeclaringType, TType>;
+    /**
+     * Configures serialized default value.
+     *
+     * @param {DefaultValue} serializedDefaultValue Serialized default value.
+     *
+     * @returns {PropertyMetadata<TDeclaringType, TType>} Current instance of property metadata.
+     */
+    configureSerializedDefaultValue(serializedDefaultValue: DefaultValue): PropertyMetadata<TDeclaringType, TType>;
+    /**
+     * Configures deserialized default value.
+     *
+     * @param {DefaultValue} deserializedDefaultValue Deserialized default value.
+     *
+     * @returns {PropertyMetadata<TDeclaringType, TType>} Current instance of property metadata.
+     */
+    configureDeserializedDefaultValue(deserializedDefaultValue: DefaultValue): PropertyMetadata<TDeclaringType, TType>;
+    /**
+     * Configures deserializable.
+     *
+     * @param {boolean} deserializable Deserializable.
+     *
+     * @returns {PropertyMetadata<TDeclaringType, TType>} Current instance of property metadata.
+     */
+    configureDeserializable(deserializable: boolean): PropertyMetadata<TDeclaringType, TType>;
+    /**
+     * Configures serializable.
+     *
+     * @param {boolean} serializable Serializable.
+     *
+     * @returns {PropertyMetadata<TDeclaringType, TType>} Current instance of property metadata.
+     */
+    configureSerializable(serializable: boolean): PropertyMetadata<TDeclaringType, TType>;
+    /**
+     * Configures generic arguments.
+     *
+     * @param {Array<GenericArgument<any>>|undefined} genericArguments Generic arguments.
+     *
+     * @returns {PropertyMetadata<TDeclaringType, TType>} Current instance of property metadata.
+     */
+    configureGenericArguments(genericArguments: Array<GenericArgument<any>> | undefined): PropertyMetadata<TDeclaringType, TType>;
+    /**
+     * Configures naming convention.
+     *
+     * @param {NamingConvention} namingConvention Naming convention.
+     *
+     * @returns {PropertyMetadata<TDeclaringType, TType>} Current instance of property metadata.
+     */
+    configureNamingConvention(namingConvention: NamingConvention): PropertyMetadata<TDeclaringType, TType>;
+    /**
+     * Configures reference handler.
+     *
+     * @param {ReferenceHandler} referenceHandler Reference handler.
+     *
+     * @returns {PropertyMetadata<TDeclaringType, TType>} Current instance of property metadata.
+     */
+    configureReferenceHandler(referenceHandler: ReferenceHandler): PropertyMetadata<TDeclaringType, TType>;
+    /**
+     * Configures serializer.
+     *
+     * @param {Serializer<TType>} serializer Serializer.
+     *
+     * @returns {PropertyMetadata<TDeclaringType, TType>} Current instance of property metadata.
+     */
+    configureSerializer(serializer: Serializer<TType>): PropertyMetadata<TDeclaringType, TType>;
+    /**
+     * Configures type argument.
+     *
+     * @param {TypeArgument<TType>} typeArgument Type argument.
+     *
+     * @returns {PropertyMetadata<TDeclaringType, TType>} Current instance of property metadata.
+     */
+    configureTypeArgument(typeArgument: TypeArgument<TType>): PropertyMetadata<TDeclaringType, TType>;
+    /**
+     * Configures preserve null.
+     *
+     * @param {boolean} preserveNull Preserve null.
+     *
+     * @returns {PropertyMetadata<TDeclaringType, TType>} Current instance of property metadata.
+     */
+    configurePreserveNull(preserveNull: boolean): PropertyMetadata<TDeclaringType, TType>;
+    /**
+     * Configures use default value.
+     *
+     * @param {boolean} useDefaultValue Use default value.
+     *
+     * @returns {PropertyMetadata<TDeclaringType, TType>} Current instance of property metadata.
+     */
+    configureUseDefaultValue(useDefaultValue: boolean): PropertyMetadata<TDeclaringType, TType>;
+    /**
+     * Configures use implicit convertion.
+     *
+     * @param {boolean} useImplicitConversion Use implicit convertion.
+     *
+     * @returns {PropertyMetadata<TDeclaringType, TType>} Current instance of property metadata.
+     */
+    configureUseImplicitConversion(useImplicitConversion: boolean): PropertyMetadata<TDeclaringType, TType>;
+    /**
+     * Configures property metadata based on provided options.
+     *
+     * @param {PropertyOptions<TType>} propertyOptions Property options.
+     *
+     * @returns {PropertyMetadata<TDeclaringType, TType>} Current instance of property metadata.
+     */
+    configure(propertyOptions: PropertyOptions<TType>): PropertyMetadata<TDeclaringType, TType>;
+}

package/property-name.d.ts

@@ -1,6 +1,6 @@
-/**
- * Type to explicitly define a property name within a source code.
- *
- * @type {PropertyName}
- */
-export declare type PropertyName = string;
+/**
+ * Type to explicitly define a property name within a source code.
+ *
+ * @type {PropertyName}
+ */
+export declare type PropertyName = string;