@dipscope/type-manager 4.1.0 → 4.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +197 -197
- package/{LICENSE.txt → LICENSE.md} +201 -201
- package/README.md +2037 -2020
- package/alias.d.ts +10 -10
- package/core/alias.d.ts +6 -6
- package/core/custom-data.d.ts +6 -6
- package/core/default-value-resolver.d.ts +7 -7
- package/core/default-value.d.ts +7 -7
- package/core/discriminant.d.ts +8 -8
- package/core/discriminator.d.ts +6 -6
- package/core/factory.d.ts +18 -18
- package/core/fn.d.ts +316 -316
- package/core/generic-argument.d.ts +7 -7
- package/core/generic-metadata.d.ts +7 -7
- package/core/index.d.ts +44 -44
- package/core/index.js +1 -1
- package/core/index.js.map +1 -0
- package/core/inject-index.d.ts +6 -6
- package/core/inject-metadata.d.ts +72 -72
- package/core/inject-options.d.ts +22 -22
- package/core/injector.d.ts +16 -16
- package/core/log-level.d.ts +11 -11
- package/core/log.d.ts +65 -65
- package/core/metadata.d.ts +42 -42
- package/core/naming-convention.d.ts +15 -15
- package/core/property-metadata.d.ts +178 -178
- package/core/property-name.d.ts +6 -6
- package/core/property-options.d.ts +100 -100
- package/core/reference-callback.d.ts +7 -7
- package/core/reference-handler.d.ts +32 -32
- package/core/reference-key.d.ts +6 -6
- package/core/reference-value-initializer.d.ts +8 -8
- package/core/reference-value-resolver.d.ts +8 -8
- package/core/reference-value.d.ts +6 -6
- package/core/serializer-context-options.d.ts +63 -63
- package/core/serializer-context.d.ts +296 -296
- package/core/serializer.d.ts +27 -27
- package/core/type-abstraction.d.ts +8 -8
- package/core/type-argument.d.ts +9 -9
- package/core/type-context-entry.d.ts +36 -36
- package/core/type-context.d.ts +58 -58
- package/core/type-ctor.d.ts +6 -6
- package/core/type-fn.d.ts +8 -8
- package/core/type-like.d.ts +7 -7
- package/core/type-metadata-resolver.d.ts +8 -8
- package/core/type-metadata-symbol.d.ts +6 -6
- package/core/type-metadata.d.ts +304 -304
- package/core/type-name.d.ts +6 -6
- package/core/type-options-base.d.ts +100 -100
- package/core/type-options.d.ts +53 -53
- package/core/type-resolver.d.ts +7 -7
- package/custom-data.d.ts +11 -11
- package/default-value.d.ts +11 -11
- package/deserializable.d.ts +11 -11
- package/deserialized-default-value.d.ts +11 -11
- package/discriminant.d.ts +11 -11
- package/discriminator.d.ts +11 -11
- package/factories/index.d.ts +1 -1
- package/factories/index.js +1 -1
- package/factories/index.js.map +1 -0
- package/factories/type-factory.d.ts +19 -19
- package/factory.d.ts +11 -11
- package/index.d.ts +24 -24
- package/index.js +1 -1
- package/index.js.map +1 -0
- package/inject.d.ts +10 -10
- package/injectable.d.ts +10 -10
- package/injector.d.ts +11 -11
- package/injectors/index.d.ts +1 -1
- package/injectors/index.js +1 -1
- package/injectors/index.js.map +1 -0
- package/injectors/singleton-injector.d.ts +31 -31
- package/naming-convention.d.ts +11 -11
- package/naming-conventions/camel-case-naming-convention.d.ts +26 -26
- package/naming-conventions/flat-case-naming-convention.d.ts +25 -25
- package/naming-conventions/flat-upper-case-naming-convention.d.ts +25 -25
- package/naming-conventions/index.d.ts +8 -8
- package/naming-conventions/index.js +1 -1
- package/naming-conventions/index.js.map +1 -0
- package/naming-conventions/kebab-case-naming-convention.d.ts +26 -26
- package/naming-conventions/kebab-upper-case-naming-convention.d.ts +26 -26
- package/naming-conventions/pascal-case-naming-convention.d.ts +26 -26
- package/naming-conventions/snake-case-naming-convention.d.ts +26 -26
- package/naming-conventions/snake-upper-case-naming-convention.d.ts +26 -26
- package/package.json +48 -48
- package/preserve-discriminator.d.ts +10 -10
- package/property.d.ts +12 -12
- package/reference-handler.d.ts +11 -11
- package/reference-handlers/direct-reference-handler.d.ts +33 -33
- package/reference-handlers/index.d.ts +3 -3
- package/reference-handlers/index.js +1 -1
- package/reference-handlers/index.js.map +1 -0
- package/reference-handlers/lead-reference-handler.d.ts +34 -34
- package/reference-handlers/path-reference-handler.d.ts +56 -56
- package/serializable.d.ts +11 -11
- package/serialized-default-value.d.ts +11 -11
- package/serializer.d.ts +11 -11
- package/serializers/array-buffer-serializer.d.ts +28 -28
- package/serializers/array-serializer.d.ts +28 -28
- package/serializers/boolean-serializer.d.ts +37 -37
- package/serializers/data-view-serializer.d.ts +28 -28
- package/serializers/date-serializer.d.ts +28 -28
- package/serializers/float-32-array-serializer.d.ts +28 -28
- package/serializers/float-64-array-serializer.d.ts +28 -28
- package/serializers/index.d.ts +19 -19
- package/serializers/index.js +1 -1
- package/serializers/index.js.map +1 -0
- package/serializers/int-16-array-serializer.d.ts +28 -28
- package/serializers/int-32-array-serializer.d.ts +28 -28
- package/serializers/int-8-array-serializer.d.ts +28 -28
- package/serializers/map-serializer.d.ts +28 -28
- package/serializers/number-serializer.d.ts +37 -37
- package/serializers/set-serializer.d.ts +28 -28
- package/serializers/string-serializer.d.ts +37 -37
- package/serializers/type-serializer.d.ts +28 -28
- package/serializers/uint-16-array-serializer.d.ts +28 -28
- package/serializers/uint-32-array-serializer.d.ts +28 -28
- package/serializers/uint-8-array-serializer.d.ts +28 -28
- package/serializers/uint-8-clamped-array-serializer.d.ts +28 -28
- package/type-and-property.d.ts +12 -12
- package/type-manager-options.d.ts +24 -24
- package/type-manager.d.ts +331 -331
- package/type.d.ts +9 -9
- package/use-default-value.d.ts +10 -10
- package/use-implicit-conversion.d.ts +10 -10
|
@@ -1,178 +1,178 @@
|
|
|
1
|
-
import { Alias } from './alias';
|
|
2
|
-
import { CustomData } from './custom-data';
|
|
3
|
-
import { GenericArgument } from './generic-argument';
|
|
4
|
-
import { GenericMetadata } from './generic-metadata';
|
|
5
|
-
import { Metadata } from './metadata';
|
|
6
|
-
import { NamingConvention } from './naming-convention';
|
|
7
|
-
import { PropertyName } from './property-name';
|
|
8
|
-
import { PropertyOptions } from './property-options';
|
|
9
|
-
import { ReferenceHandler } from './reference-handler';
|
|
10
|
-
import { Serializer } from './serializer';
|
|
11
|
-
import { TypeArgument } from './type-argument';
|
|
12
|
-
import { TypeFn } from './type-fn';
|
|
13
|
-
import { TypeMetadata } from './type-metadata';
|
|
14
|
-
/**
|
|
15
|
-
* Main class used to describe a certain property.
|
|
16
|
-
*
|
|
17
|
-
* @type {PropertyMetadata<TDeclaringType, TType>}
|
|
18
|
-
*/
|
|
19
|
-
export declare class PropertyMetadata<TDeclaringType, TType> extends Metadata {
|
|
20
|
-
/**
|
|
21
|
-
* Type metadata to which property metadata belongs to.
|
|
22
|
-
*
|
|
23
|
-
* @type {TypeMetadata<TDeclaringType>}
|
|
24
|
-
*/
|
|
25
|
-
readonly declaringTypeMetadata: TypeMetadata<TDeclaringType>;
|
|
26
|
-
/**
|
|
27
|
-
* Type function defined using reflect metadata.
|
|
28
|
-
*
|
|
29
|
-
* Used as a fallback when type argument is not defined.
|
|
30
|
-
*
|
|
31
|
-
* @type {TypeFn<TType>}
|
|
32
|
-
*/
|
|
33
|
-
readonly reflectTypeFn: TypeFn<TType>;
|
|
34
|
-
/**
|
|
35
|
-
* Property name as declared in type.
|
|
36
|
-
*
|
|
37
|
-
* @type {PropertyName}
|
|
38
|
-
*/
|
|
39
|
-
readonly propertyName: PropertyName;
|
|
40
|
-
/**
|
|
41
|
-
* Property options.
|
|
42
|
-
*
|
|
43
|
-
* @type {PropertyOptions<TType>}
|
|
44
|
-
*/
|
|
45
|
-
readonly propertyOptions: PropertyOptions<TType>;
|
|
46
|
-
/**
|
|
47
|
-
* Constructor.
|
|
48
|
-
*
|
|
49
|
-
* @param {TypeMetadata<TDeclaringType>} declaringTypeMetadata Type metadata to which property metadata belongs to.
|
|
50
|
-
* @param {PropertyName} propertyName Property name.
|
|
51
|
-
* @param {PropertyOptions<TType>} propertyOptions Property options.
|
|
52
|
-
*/
|
|
53
|
-
constructor(declaringTypeMetadata: TypeMetadata<TDeclaringType>, propertyName: PropertyName, propertyOptions: PropertyOptions<TType>);
|
|
54
|
-
/**
|
|
55
|
-
* Gets alias.
|
|
56
|
-
*
|
|
57
|
-
* @returns {Alias|undefined} Alias or undefined.
|
|
58
|
-
*/
|
|
59
|
-
get alias(): Alias | undefined;
|
|
60
|
-
/**
|
|
61
|
-
* Gets custom data.
|
|
62
|
-
*
|
|
63
|
-
* @returns {CustomData} Custom data.
|
|
64
|
-
*/
|
|
65
|
-
get customData(): CustomData;
|
|
66
|
-
/**
|
|
67
|
-
* Gets serialized default value.
|
|
68
|
-
*
|
|
69
|
-
* @returns {any|undefined} Resolved serialized default value or undefined.
|
|
70
|
-
*/
|
|
71
|
-
get serializedDefaultValue(): any | undefined;
|
|
72
|
-
/**
|
|
73
|
-
* Gets deserialized default value.
|
|
74
|
-
*
|
|
75
|
-
* @returns {any|undefined} Resolved deserialized default value or undefined.
|
|
76
|
-
*/
|
|
77
|
-
get deserializedDefaultValue(): any | undefined;
|
|
78
|
-
/**
|
|
79
|
-
* Gets serialized property name.
|
|
80
|
-
*
|
|
81
|
-
* @returns {string} Serialized property name.
|
|
82
|
-
*/
|
|
83
|
-
get serializedPropertyName(): string;
|
|
84
|
-
/**
|
|
85
|
-
* Gets deserialized property name.
|
|
86
|
-
*
|
|
87
|
-
* @returns {string} Deserialized property name.
|
|
88
|
-
*/
|
|
89
|
-
get deserializedPropertyName(): string;
|
|
90
|
-
/**
|
|
91
|
-
* Gets deserializable value.
|
|
92
|
-
*
|
|
93
|
-
* @returns {boolean|undefined} Deserializable indicator or undefined.
|
|
94
|
-
*/
|
|
95
|
-
get deserializable(): boolean | undefined;
|
|
96
|
-
/**
|
|
97
|
-
* Gets generic arguments.
|
|
98
|
-
*
|
|
99
|
-
* @returns {Array<GenericArgument<any>>|undefined} Generic arguments or undefined.
|
|
100
|
-
*/
|
|
101
|
-
get genericArguments(): Array<GenericArgument<any>> | undefined;
|
|
102
|
-
/**
|
|
103
|
-
* Gets generic metadatas.
|
|
104
|
-
*
|
|
105
|
-
* @returns {Array<GenericMetadata<any>>|undefined} Generic metadatas.
|
|
106
|
-
*/
|
|
107
|
-
get genericMetadatas(): Array<GenericMetadata<any>> | undefined;
|
|
108
|
-
/**
|
|
109
|
-
* Gets naming convention.
|
|
110
|
-
*
|
|
111
|
-
* @returns {NamingConvention|undefined} Naming convention or undefined.
|
|
112
|
-
*/
|
|
113
|
-
get namingConvention(): NamingConvention | undefined;
|
|
114
|
-
/**
|
|
115
|
-
* Gets reference handler.
|
|
116
|
-
*
|
|
117
|
-
* @returns {ReferenceHandler} Reference handler.
|
|
118
|
-
*/
|
|
119
|
-
get referenceHandler(): ReferenceHandler;
|
|
120
|
-
/**
|
|
121
|
-
* Gets serializable value.
|
|
122
|
-
*
|
|
123
|
-
* @returns {boolean|undefined} Serializable indicator or undefined.
|
|
124
|
-
*/
|
|
125
|
-
get serializable(): boolean | undefined;
|
|
126
|
-
/**
|
|
127
|
-
* Checks if serialization configured.
|
|
128
|
-
*
|
|
129
|
-
* @returns {boolean} True when serialization configured. False otherwise.
|
|
130
|
-
*/
|
|
131
|
-
get serializationConfigured(): boolean;
|
|
132
|
-
/**
|
|
133
|
-
* Gets serializer.
|
|
134
|
-
*
|
|
135
|
-
* @returns {Serializer<TType>} Serializer.
|
|
136
|
-
*/
|
|
137
|
-
get serializer(): Serializer<TType>;
|
|
138
|
-
/**
|
|
139
|
-
* Gets type argument.
|
|
140
|
-
*
|
|
141
|
-
* @returns {TypeArgument|undefined} Type argument or undefined.
|
|
142
|
-
*/
|
|
143
|
-
get typeArgument(): TypeArgument<TType> | undefined;
|
|
144
|
-
/**
|
|
145
|
-
* Gets type metadata.
|
|
146
|
-
*
|
|
147
|
-
* @returns {TypeMetadata<TType>} Type metadata.
|
|
148
|
-
*/
|
|
149
|
-
get typeMetadata(): TypeMetadata<TType>;
|
|
150
|
-
/**
|
|
151
|
-
* Gets indicator if default value should be used.
|
|
152
|
-
*
|
|
153
|
-
* @returns {boolean} Use default value indicator.
|
|
154
|
-
*/
|
|
155
|
-
get useDefaultValue(): boolean;
|
|
156
|
-
/**
|
|
157
|
-
* Gets indicator if implicit conversion should be used.
|
|
158
|
-
*
|
|
159
|
-
* @returns {boolean} Use implicit conversion indicator.
|
|
160
|
-
*/
|
|
161
|
-
get useImplicitConversion(): boolean;
|
|
162
|
-
/**
|
|
163
|
-
* Configures custom data.
|
|
164
|
-
*
|
|
165
|
-
* @param {CustomData} customData Custom data.
|
|
166
|
-
*
|
|
167
|
-
* @returns {PropertyMetadata<TDeclaringType, TType>} Instance of property metadata.
|
|
168
|
-
*/
|
|
169
|
-
private configureCustomData;
|
|
170
|
-
/**
|
|
171
|
-
* Configures property metadata based on provided options.
|
|
172
|
-
*
|
|
173
|
-
* @param {PropertyOptions<TType>} propertyOptions Property options.
|
|
174
|
-
*
|
|
175
|
-
* @returns {PropertyMetadata<TDeclaringType, TType>} Instance of property metadata.
|
|
176
|
-
*/
|
|
177
|
-
configure(propertyOptions: PropertyOptions<TType>): PropertyMetadata<TDeclaringType, TType>;
|
|
178
|
-
}
|
|
1
|
+
import { Alias } from './alias';
|
|
2
|
+
import { CustomData } from './custom-data';
|
|
3
|
+
import { GenericArgument } from './generic-argument';
|
|
4
|
+
import { GenericMetadata } from './generic-metadata';
|
|
5
|
+
import { Metadata } from './metadata';
|
|
6
|
+
import { NamingConvention } from './naming-convention';
|
|
7
|
+
import { PropertyName } from './property-name';
|
|
8
|
+
import { PropertyOptions } from './property-options';
|
|
9
|
+
import { ReferenceHandler } from './reference-handler';
|
|
10
|
+
import { Serializer } from './serializer';
|
|
11
|
+
import { TypeArgument } from './type-argument';
|
|
12
|
+
import { TypeFn } from './type-fn';
|
|
13
|
+
import { TypeMetadata } from './type-metadata';
|
|
14
|
+
/**
|
|
15
|
+
* Main class used to describe a certain property.
|
|
16
|
+
*
|
|
17
|
+
* @type {PropertyMetadata<TDeclaringType, TType>}
|
|
18
|
+
*/
|
|
19
|
+
export declare class PropertyMetadata<TDeclaringType, TType> extends Metadata {
|
|
20
|
+
/**
|
|
21
|
+
* Type metadata to which property metadata belongs to.
|
|
22
|
+
*
|
|
23
|
+
* @type {TypeMetadata<TDeclaringType>}
|
|
24
|
+
*/
|
|
25
|
+
readonly declaringTypeMetadata: TypeMetadata<TDeclaringType>;
|
|
26
|
+
/**
|
|
27
|
+
* Type function defined using reflect metadata.
|
|
28
|
+
*
|
|
29
|
+
* Used as a fallback when type argument is not defined.
|
|
30
|
+
*
|
|
31
|
+
* @type {TypeFn<TType>}
|
|
32
|
+
*/
|
|
33
|
+
readonly reflectTypeFn: TypeFn<TType>;
|
|
34
|
+
/**
|
|
35
|
+
* Property name as declared in type.
|
|
36
|
+
*
|
|
37
|
+
* @type {PropertyName}
|
|
38
|
+
*/
|
|
39
|
+
readonly propertyName: PropertyName;
|
|
40
|
+
/**
|
|
41
|
+
* Property options.
|
|
42
|
+
*
|
|
43
|
+
* @type {PropertyOptions<TType>}
|
|
44
|
+
*/
|
|
45
|
+
readonly propertyOptions: PropertyOptions<TType>;
|
|
46
|
+
/**
|
|
47
|
+
* Constructor.
|
|
48
|
+
*
|
|
49
|
+
* @param {TypeMetadata<TDeclaringType>} declaringTypeMetadata Type metadata to which property metadata belongs to.
|
|
50
|
+
* @param {PropertyName} propertyName Property name.
|
|
51
|
+
* @param {PropertyOptions<TType>} propertyOptions Property options.
|
|
52
|
+
*/
|
|
53
|
+
constructor(declaringTypeMetadata: TypeMetadata<TDeclaringType>, propertyName: PropertyName, propertyOptions: PropertyOptions<TType>);
|
|
54
|
+
/**
|
|
55
|
+
* Gets alias.
|
|
56
|
+
*
|
|
57
|
+
* @returns {Alias|undefined} Alias or undefined.
|
|
58
|
+
*/
|
|
59
|
+
get alias(): Alias | undefined;
|
|
60
|
+
/**
|
|
61
|
+
* Gets custom data.
|
|
62
|
+
*
|
|
63
|
+
* @returns {CustomData} Custom data.
|
|
64
|
+
*/
|
|
65
|
+
get customData(): CustomData;
|
|
66
|
+
/**
|
|
67
|
+
* Gets serialized default value.
|
|
68
|
+
*
|
|
69
|
+
* @returns {any|undefined} Resolved serialized default value or undefined.
|
|
70
|
+
*/
|
|
71
|
+
get serializedDefaultValue(): any | undefined;
|
|
72
|
+
/**
|
|
73
|
+
* Gets deserialized default value.
|
|
74
|
+
*
|
|
75
|
+
* @returns {any|undefined} Resolved deserialized default value or undefined.
|
|
76
|
+
*/
|
|
77
|
+
get deserializedDefaultValue(): any | undefined;
|
|
78
|
+
/**
|
|
79
|
+
* Gets serialized property name.
|
|
80
|
+
*
|
|
81
|
+
* @returns {string} Serialized property name.
|
|
82
|
+
*/
|
|
83
|
+
get serializedPropertyName(): string;
|
|
84
|
+
/**
|
|
85
|
+
* Gets deserialized property name.
|
|
86
|
+
*
|
|
87
|
+
* @returns {string} Deserialized property name.
|
|
88
|
+
*/
|
|
89
|
+
get deserializedPropertyName(): string;
|
|
90
|
+
/**
|
|
91
|
+
* Gets deserializable value.
|
|
92
|
+
*
|
|
93
|
+
* @returns {boolean|undefined} Deserializable indicator or undefined.
|
|
94
|
+
*/
|
|
95
|
+
get deserializable(): boolean | undefined;
|
|
96
|
+
/**
|
|
97
|
+
* Gets generic arguments.
|
|
98
|
+
*
|
|
99
|
+
* @returns {Array<GenericArgument<any>>|undefined} Generic arguments or undefined.
|
|
100
|
+
*/
|
|
101
|
+
get genericArguments(): Array<GenericArgument<any>> | undefined;
|
|
102
|
+
/**
|
|
103
|
+
* Gets generic metadatas.
|
|
104
|
+
*
|
|
105
|
+
* @returns {Array<GenericMetadata<any>>|undefined} Generic metadatas.
|
|
106
|
+
*/
|
|
107
|
+
get genericMetadatas(): Array<GenericMetadata<any>> | undefined;
|
|
108
|
+
/**
|
|
109
|
+
* Gets naming convention.
|
|
110
|
+
*
|
|
111
|
+
* @returns {NamingConvention|undefined} Naming convention or undefined.
|
|
112
|
+
*/
|
|
113
|
+
get namingConvention(): NamingConvention | undefined;
|
|
114
|
+
/**
|
|
115
|
+
* Gets reference handler.
|
|
116
|
+
*
|
|
117
|
+
* @returns {ReferenceHandler} Reference handler.
|
|
118
|
+
*/
|
|
119
|
+
get referenceHandler(): ReferenceHandler;
|
|
120
|
+
/**
|
|
121
|
+
* Gets serializable value.
|
|
122
|
+
*
|
|
123
|
+
* @returns {boolean|undefined} Serializable indicator or undefined.
|
|
124
|
+
*/
|
|
125
|
+
get serializable(): boolean | undefined;
|
|
126
|
+
/**
|
|
127
|
+
* Checks if serialization configured.
|
|
128
|
+
*
|
|
129
|
+
* @returns {boolean} True when serialization configured. False otherwise.
|
|
130
|
+
*/
|
|
131
|
+
get serializationConfigured(): boolean;
|
|
132
|
+
/**
|
|
133
|
+
* Gets serializer.
|
|
134
|
+
*
|
|
135
|
+
* @returns {Serializer<TType>} Serializer.
|
|
136
|
+
*/
|
|
137
|
+
get serializer(): Serializer<TType>;
|
|
138
|
+
/**
|
|
139
|
+
* Gets type argument.
|
|
140
|
+
*
|
|
141
|
+
* @returns {TypeArgument|undefined} Type argument or undefined.
|
|
142
|
+
*/
|
|
143
|
+
get typeArgument(): TypeArgument<TType> | undefined;
|
|
144
|
+
/**
|
|
145
|
+
* Gets type metadata.
|
|
146
|
+
*
|
|
147
|
+
* @returns {TypeMetadata<TType>} Type metadata.
|
|
148
|
+
*/
|
|
149
|
+
get typeMetadata(): TypeMetadata<TType>;
|
|
150
|
+
/**
|
|
151
|
+
* Gets indicator if default value should be used.
|
|
152
|
+
*
|
|
153
|
+
* @returns {boolean} Use default value indicator.
|
|
154
|
+
*/
|
|
155
|
+
get useDefaultValue(): boolean;
|
|
156
|
+
/**
|
|
157
|
+
* Gets indicator if implicit conversion should be used.
|
|
158
|
+
*
|
|
159
|
+
* @returns {boolean} Use implicit conversion indicator.
|
|
160
|
+
*/
|
|
161
|
+
get useImplicitConversion(): boolean;
|
|
162
|
+
/**
|
|
163
|
+
* Configures custom data.
|
|
164
|
+
*
|
|
165
|
+
* @param {CustomData} customData Custom data.
|
|
166
|
+
*
|
|
167
|
+
* @returns {PropertyMetadata<TDeclaringType, TType>} Instance of property metadata.
|
|
168
|
+
*/
|
|
169
|
+
private configureCustomData;
|
|
170
|
+
/**
|
|
171
|
+
* Configures property metadata based on provided options.
|
|
172
|
+
*
|
|
173
|
+
* @param {PropertyOptions<TType>} propertyOptions Property options.
|
|
174
|
+
*
|
|
175
|
+
* @returns {PropertyMetadata<TDeclaringType, TType>} Instance of property metadata.
|
|
176
|
+
*/
|
|
177
|
+
configure(propertyOptions: PropertyOptions<TType>): PropertyMetadata<TDeclaringType, TType>;
|
|
178
|
+
}
|
package/core/property-name.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Type to explicitly define a property name within a source code.
|
|
3
|
-
*
|
|
4
|
-
* @type {PropertyName}
|
|
5
|
-
*/
|
|
6
|
-
export declare type PropertyName = string;
|
|
1
|
+
/**
|
|
2
|
+
* Type to explicitly define a property name within a source code.
|
|
3
|
+
*
|
|
4
|
+
* @type {PropertyName}
|
|
5
|
+
*/
|
|
6
|
+
export declare type PropertyName = string;
|
|
@@ -1,100 +1,100 @@
|
|
|
1
|
-
import { Alias } from './alias';
|
|
2
|
-
import { CustomData } from './custom-data';
|
|
3
|
-
import { DefaultValue } from './default-value';
|
|
4
|
-
import { GenericArgument } from './generic-argument';
|
|
5
|
-
import { NamingConvention } from './naming-convention';
|
|
6
|
-
import { ReferenceHandler } from './reference-handler';
|
|
7
|
-
import { Serializer } from './serializer';
|
|
8
|
-
import { TypeArgument } from './type-argument';
|
|
9
|
-
/**
|
|
10
|
-
* Property options.
|
|
11
|
-
*
|
|
12
|
-
* @type {PropertyOptions<TType>}
|
|
13
|
-
*/
|
|
14
|
-
export interface PropertyOptions<TType> {
|
|
15
|
-
/**
|
|
16
|
-
* Property alias.
|
|
17
|
-
*
|
|
18
|
-
* Used if property name in object differs from declared for type.
|
|
19
|
-
*
|
|
20
|
-
* @type {Alias}
|
|
21
|
-
*/
|
|
22
|
-
alias?: Alias;
|
|
23
|
-
/**
|
|
24
|
-
* Custom developer data.
|
|
25
|
-
*
|
|
26
|
-
* @type {CustomData}
|
|
27
|
-
*/
|
|
28
|
-
customData?: CustomData;
|
|
29
|
-
/**
|
|
30
|
-
* Serialized default value for undefined ones.
|
|
31
|
-
*
|
|
32
|
-
* Used only when use default value option is true.
|
|
33
|
-
*
|
|
34
|
-
* @type {DefaultValue}
|
|
35
|
-
*/
|
|
36
|
-
serializedDefaultValue?: DefaultValue;
|
|
37
|
-
/**
|
|
38
|
-
* Deserialized default value for undefined ones.
|
|
39
|
-
*
|
|
40
|
-
* Used only when use default value option is true.
|
|
41
|
-
*
|
|
42
|
-
* @type {DefaultValue}
|
|
43
|
-
*/
|
|
44
|
-
deserializedDefaultValue?: DefaultValue;
|
|
45
|
-
/**
|
|
46
|
-
* Deserializable from object?
|
|
47
|
-
*
|
|
48
|
-
* @type {boolean}
|
|
49
|
-
*/
|
|
50
|
-
deserializable?: boolean;
|
|
51
|
-
/**
|
|
52
|
-
* Generic arguments.
|
|
53
|
-
*
|
|
54
|
-
* @type {Array<GenericArgument<any>>}
|
|
55
|
-
*/
|
|
56
|
-
genericArguments?: Array<GenericArgument<any>>;
|
|
57
|
-
/**
|
|
58
|
-
* Naming convention.
|
|
59
|
-
*
|
|
60
|
-
* @type {NamingConvention}
|
|
61
|
-
*/
|
|
62
|
-
namingConvention?: NamingConvention;
|
|
63
|
-
/**
|
|
64
|
-
* Reference handler.
|
|
65
|
-
*
|
|
66
|
-
* @type {ReferenceHandler}
|
|
67
|
-
*/
|
|
68
|
-
referenceHandler?: ReferenceHandler;
|
|
69
|
-
/**
|
|
70
|
-
* Serializable to object?
|
|
71
|
-
*
|
|
72
|
-
* @type {boolean}
|
|
73
|
-
*/
|
|
74
|
-
serializable?: boolean;
|
|
75
|
-
/**
|
|
76
|
-
* Serializer used to serialize and deserialize a property.
|
|
77
|
-
*
|
|
78
|
-
* @type {Serializer<TType>}
|
|
79
|
-
*/
|
|
80
|
-
serializer?: Serializer<TType>;
|
|
81
|
-
/**
|
|
82
|
-
* Type argument.
|
|
83
|
-
*
|
|
84
|
-
* @type {TypeArgument<TType>}
|
|
85
|
-
*/
|
|
86
|
-
typeArgument?: TypeArgument<TType>;
|
|
87
|
-
/**
|
|
88
|
-
* Use default value assignment for undefined values?
|
|
89
|
-
*
|
|
90
|
-
* @type {boolean}
|
|
91
|
-
*/
|
|
92
|
-
useDefaultValue?: boolean;
|
|
93
|
-
/**
|
|
94
|
-
* Use implicit conversion when provided value can be converted
|
|
95
|
-
* to the target one?
|
|
96
|
-
*
|
|
97
|
-
* @type {boolean}
|
|
98
|
-
*/
|
|
99
|
-
useImplicitConversion?: boolean;
|
|
100
|
-
}
|
|
1
|
+
import { Alias } from './alias';
|
|
2
|
+
import { CustomData } from './custom-data';
|
|
3
|
+
import { DefaultValue } from './default-value';
|
|
4
|
+
import { GenericArgument } from './generic-argument';
|
|
5
|
+
import { NamingConvention } from './naming-convention';
|
|
6
|
+
import { ReferenceHandler } from './reference-handler';
|
|
7
|
+
import { Serializer } from './serializer';
|
|
8
|
+
import { TypeArgument } from './type-argument';
|
|
9
|
+
/**
|
|
10
|
+
* Property options.
|
|
11
|
+
*
|
|
12
|
+
* @type {PropertyOptions<TType>}
|
|
13
|
+
*/
|
|
14
|
+
export interface PropertyOptions<TType> {
|
|
15
|
+
/**
|
|
16
|
+
* Property alias.
|
|
17
|
+
*
|
|
18
|
+
* Used if property name in object differs from declared for type.
|
|
19
|
+
*
|
|
20
|
+
* @type {Alias}
|
|
21
|
+
*/
|
|
22
|
+
alias?: Alias;
|
|
23
|
+
/**
|
|
24
|
+
* Custom developer data.
|
|
25
|
+
*
|
|
26
|
+
* @type {CustomData}
|
|
27
|
+
*/
|
|
28
|
+
customData?: CustomData;
|
|
29
|
+
/**
|
|
30
|
+
* Serialized default value for undefined ones.
|
|
31
|
+
*
|
|
32
|
+
* Used only when use default value option is true.
|
|
33
|
+
*
|
|
34
|
+
* @type {DefaultValue}
|
|
35
|
+
*/
|
|
36
|
+
serializedDefaultValue?: DefaultValue;
|
|
37
|
+
/**
|
|
38
|
+
* Deserialized default value for undefined ones.
|
|
39
|
+
*
|
|
40
|
+
* Used only when use default value option is true.
|
|
41
|
+
*
|
|
42
|
+
* @type {DefaultValue}
|
|
43
|
+
*/
|
|
44
|
+
deserializedDefaultValue?: DefaultValue;
|
|
45
|
+
/**
|
|
46
|
+
* Deserializable from object?
|
|
47
|
+
*
|
|
48
|
+
* @type {boolean}
|
|
49
|
+
*/
|
|
50
|
+
deserializable?: boolean;
|
|
51
|
+
/**
|
|
52
|
+
* Generic arguments.
|
|
53
|
+
*
|
|
54
|
+
* @type {Array<GenericArgument<any>>}
|
|
55
|
+
*/
|
|
56
|
+
genericArguments?: Array<GenericArgument<any>>;
|
|
57
|
+
/**
|
|
58
|
+
* Naming convention.
|
|
59
|
+
*
|
|
60
|
+
* @type {NamingConvention}
|
|
61
|
+
*/
|
|
62
|
+
namingConvention?: NamingConvention;
|
|
63
|
+
/**
|
|
64
|
+
* Reference handler.
|
|
65
|
+
*
|
|
66
|
+
* @type {ReferenceHandler}
|
|
67
|
+
*/
|
|
68
|
+
referenceHandler?: ReferenceHandler;
|
|
69
|
+
/**
|
|
70
|
+
* Serializable to object?
|
|
71
|
+
*
|
|
72
|
+
* @type {boolean}
|
|
73
|
+
*/
|
|
74
|
+
serializable?: boolean;
|
|
75
|
+
/**
|
|
76
|
+
* Serializer used to serialize and deserialize a property.
|
|
77
|
+
*
|
|
78
|
+
* @type {Serializer<TType>}
|
|
79
|
+
*/
|
|
80
|
+
serializer?: Serializer<TType>;
|
|
81
|
+
/**
|
|
82
|
+
* Type argument.
|
|
83
|
+
*
|
|
84
|
+
* @type {TypeArgument<TType>}
|
|
85
|
+
*/
|
|
86
|
+
typeArgument?: TypeArgument<TType>;
|
|
87
|
+
/**
|
|
88
|
+
* Use default value assignment for undefined values?
|
|
89
|
+
*
|
|
90
|
+
* @type {boolean}
|
|
91
|
+
*/
|
|
92
|
+
useDefaultValue?: boolean;
|
|
93
|
+
/**
|
|
94
|
+
* Use implicit conversion when provided value can be converted
|
|
95
|
+
* to the target one?
|
|
96
|
+
*
|
|
97
|
+
* @type {boolean}
|
|
98
|
+
*/
|
|
99
|
+
useImplicitConversion?: boolean;
|
|
100
|
+
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Reference callback function which is called when circular references can be resolved for
|
|
3
|
-
* a certain object. May be created by serializers for serializer contexts.
|
|
4
|
-
*
|
|
5
|
-
* @type {ReferenceCallback}
|
|
6
|
-
*/
|
|
7
|
-
export declare type ReferenceCallback = () => void;
|
|
1
|
+
/**
|
|
2
|
+
* Reference callback function which is called when circular references can be resolved for
|
|
3
|
+
* a certain object. May be created by serializers for serializer contexts.
|
|
4
|
+
*
|
|
5
|
+
* @type {ReferenceCallback}
|
|
6
|
+
*/
|
|
7
|
+
export declare type ReferenceCallback = () => void;
|
|
@@ -1,32 +1,32 @@
|
|
|
1
|
-
import { ReferenceKey } from './reference-key';
|
|
2
|
-
import { ReferenceValue } from './reference-value';
|
|
3
|
-
import { ReferenceValueInitializer } from './reference-value-initializer';
|
|
4
|
-
import { ReferenceValueResolver } from './reference-value-resolver';
|
|
5
|
-
import { SerializerContext } from './serializer-context';
|
|
6
|
-
/**
|
|
7
|
-
* Reference handler to resolve object references.
|
|
8
|
-
*
|
|
9
|
-
* @type {ReferenceHandler}
|
|
10
|
-
*/
|
|
11
|
-
export interface ReferenceHandler {
|
|
12
|
-
/**
|
|
13
|
-
* Defines reference. Called during serialization.
|
|
14
|
-
*
|
|
15
|
-
* @param {SerializerContext<any>} serializerContext Serializer context.
|
|
16
|
-
* @param {ReferenceKey} referenceKey Reference which acts as a key. This is basically a serializing object.
|
|
17
|
-
* @param {ReferenceValueInitializer} referenceValueInitializer Function to initialize a reference value when one is not yet present for a key.
|
|
18
|
-
*
|
|
19
|
-
* @returns {ReferenceValue|ReferenceValueResolver} Resolved reference value or reference resolver when circular dependency is detected.
|
|
20
|
-
*/
|
|
21
|
-
define(serializerContext: SerializerContext<any>, referenceKey: ReferenceKey, referenceValueInitializer: ReferenceValueInitializer): ReferenceValue | ReferenceValueResolver;
|
|
22
|
-
/**
|
|
23
|
-
* Restores reference. Called during deserialization.
|
|
24
|
-
*
|
|
25
|
-
* @param {SerializerContext<any>} serializerContext Serializer context.
|
|
26
|
-
* @param {ReferenceKey} referenceKey Reference which acts as a key. This is basically a deserializing object.
|
|
27
|
-
* @param {ReferenceValueInitializer} referenceValueInitializer Function to initialize a reference value when one is not yet present for a key.
|
|
28
|
-
*
|
|
29
|
-
* @returns {ReferenceValue|ReferenceValueResolver} Resolved reference value or reference resolver when circular dependency is detected.
|
|
30
|
-
*/
|
|
31
|
-
restore(serializerContext: SerializerContext<any>, referenceKey: ReferenceKey, referenceValueInitializer: ReferenceValueInitializer): ReferenceValue | ReferenceValueResolver;
|
|
32
|
-
}
|
|
1
|
+
import { ReferenceKey } from './reference-key';
|
|
2
|
+
import { ReferenceValue } from './reference-value';
|
|
3
|
+
import { ReferenceValueInitializer } from './reference-value-initializer';
|
|
4
|
+
import { ReferenceValueResolver } from './reference-value-resolver';
|
|
5
|
+
import { SerializerContext } from './serializer-context';
|
|
6
|
+
/**
|
|
7
|
+
* Reference handler to resolve object references.
|
|
8
|
+
*
|
|
9
|
+
* @type {ReferenceHandler}
|
|
10
|
+
*/
|
|
11
|
+
export interface ReferenceHandler {
|
|
12
|
+
/**
|
|
13
|
+
* Defines reference. Called during serialization.
|
|
14
|
+
*
|
|
15
|
+
* @param {SerializerContext<any>} serializerContext Serializer context.
|
|
16
|
+
* @param {ReferenceKey} referenceKey Reference which acts as a key. This is basically a serializing object.
|
|
17
|
+
* @param {ReferenceValueInitializer} referenceValueInitializer Function to initialize a reference value when one is not yet present for a key.
|
|
18
|
+
*
|
|
19
|
+
* @returns {ReferenceValue|ReferenceValueResolver} Resolved reference value or reference resolver when circular dependency is detected.
|
|
20
|
+
*/
|
|
21
|
+
define(serializerContext: SerializerContext<any>, referenceKey: ReferenceKey, referenceValueInitializer: ReferenceValueInitializer): ReferenceValue | ReferenceValueResolver;
|
|
22
|
+
/**
|
|
23
|
+
* Restores reference. Called during deserialization.
|
|
24
|
+
*
|
|
25
|
+
* @param {SerializerContext<any>} serializerContext Serializer context.
|
|
26
|
+
* @param {ReferenceKey} referenceKey Reference which acts as a key. This is basically a deserializing object.
|
|
27
|
+
* @param {ReferenceValueInitializer} referenceValueInitializer Function to initialize a reference value when one is not yet present for a key.
|
|
28
|
+
*
|
|
29
|
+
* @returns {ReferenceValue|ReferenceValueResolver} Resolved reference value or reference resolver when circular dependency is detected.
|
|
30
|
+
*/
|
|
31
|
+
restore(serializerContext: SerializerContext<any>, referenceKey: ReferenceKey, referenceValueInitializer: ReferenceValueInitializer): ReferenceValue | ReferenceValueResolver;
|
|
32
|
+
}
|
package/core/reference-key.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Reference key is an object which identifies unique reference value.
|
|
3
|
-
*
|
|
4
|
-
* @type {ReferenceKey}
|
|
5
|
-
*/
|
|
6
|
-
export declare type ReferenceKey = Record<string, any>;
|
|
1
|
+
/**
|
|
2
|
+
* Reference key is an object which identifies unique reference value.
|
|
3
|
+
*
|
|
4
|
+
* @type {ReferenceKey}
|
|
5
|
+
*/
|
|
6
|
+
export declare type ReferenceKey = Record<string, any>;
|