@dipscope/type-manager 4.0.4 → 5.0.0-beta.0

package/alias.d.ts

@@ -1,10 +1,6 @@
 /**
- * Alias decorator.
+ * Type to explicitly define an alias within a source code.
  *
- * Can be used on type and property to define an alias.
- *
- * @param {string} alias Type or property alias.
- *
- * @returns {ClassDecorator&PropertyDecorator} Class and property decorator.
+ * @type {Alias}
  */
-export declare function Alias(alias: string): ClassDecorator & PropertyDecorator;
+export declare type Alias = string;

package/custom-data.d.ts

@@ -1,11 +1,6 @@
-import { CustomData } from './core';
 /**
- * Custom data decorator.
+ * Custom data which can be defined by developer.
  *
- * Used to define custom data for type and property.
- *
- * @param {CustomData} customData Custom data.
- *
- * @returns {ClassDecorator&PropertyDecorator} Class and property decorator.
+ * @type {CustomData}
  */
-export declare function CustomData(customData: CustomData): ClassDecorator & PropertyDecorator;
+export declare type CustomData = Record<string, any>;

package/default-value-resolver.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Resolver used to get default value. May be used if type represents a reference
+ * which have to be unique.
+ *
+ * @type {DefaultValueResolver}
+ */
+export declare type DefaultValueResolver = () => any;

package/default-value.d.ts

@@ -1,10 +1,7 @@
+import { DefaultValueResolver } from './default-value-resolver';
 /**
- * Default value decorator.
+ * Default value which can be defined by developer.
  *
- * Used to define default value for type and property.
- *
- * @param {any} defaultValue Default value.
- *
- * @returns {ClassDecorator&PropertyDecorator} Class and property decorator.
+ * @type {DefaultValue}
  */
-export declare function DefaultValue(defaultValue: any): ClassDecorator & PropertyDecorator;
+export declare type DefaultValue = any | DefaultValueResolver;

package/discriminant.d.ts

@@ -1,11 +1,8 @@
-import { Discriminant } from './core/discriminant';
+import { TypeName } from './type-name';
 /**
- * Discriminant decorator.
+ * Discriminant intends to describe a unique key for a polymorphic type which will be
+ * used during serialization and deserialization. Can be a type name, any string or number.
  *
- * Used to define a discriminant for a type.
- *
- * @param {Discriminant} discriminant Discriminant.
- *
- * @returns {ClassDecorator} Class decorator.
+ * @type {Discriminant}
  */
-export declare function Discriminant(discriminant: Discriminant): ClassDecorator;
+export declare type Discriminant = TypeName | string | number;

package/discriminator.d.ts

@@ -1,11 +1,6 @@
-import { Discriminator } from './core/discriminator';
 /**
- * Discriminator decorator.
+ * Discriminator intends to indicate the property used to identify the type of an object.
  *
- * Used to define a discriminator for a type.
- *
- * @param {Discriminator} discriminator Discriminator.
- *
- * @returns {ClassDecorator} Class decorator.
+ * @type {Discriminator}
  */
-export declare function Discriminator(discriminator: Discriminator): ClassDecorator;
+export declare type Discriminator = string;

package/factories/type-factory.d.ts

@@ -1,6 +1,6 @@
-import { Factory } from '../core/factory';
-import { Injector } from '../core/injector';
-import { TypeContext } from '../core/type-context';
+import { Factory } from '../factory';
+import { Injector } from '../injector';
+import { TypeContext } from '../type-context';
 /**
  * Type factory.
  *

package/factory.d.ts

@@ -1,11 +1,18 @@
-import { Factory } from './core/factory';
+import { Injector } from './injector';
+import { TypeContext } from './type-context';
 /**
- * Factory decorator.
+ * Factory for building types.
  *
- * Used to define custom factory for a type.
- *
- * @param {Factory} factory Factory.
- *
- * @returns {ClassDecorator} Class decorator.
+ * @type {Factory}
  */
-export declare function Factory(factory: Factory): ClassDecorator;
+export interface Factory {
+    /**
+     * Builds type described by provided type context.
+     *
+     * @param {TypeContext<TType>} typeContext Type context.
+     * @param {Injector} injector Injector.
+     *
+     * @returns {TType} Type instance described by provided type context.
+     */
+    build<TType>(typeContext: TypeContext<TType>, injector: Injector): TType;
+}

package/functions/get-own-reflect-metadata.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Gets own reflect metadata.
+ *
+ * @param {string} metadataKey Unique metadata key.
+ * @param {any} target Target to extract from.
+ *
+ * @returns {any} Metadata for a key or undefined if metadata is not present.
+ */
+export declare function getOwnReflectMetadata(metadataKey: string, target: any): any;

package/functions/get-reflect-metadata.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Gets reflect metadata.
+ *
+ * @param {string} metadataKey Unique metadata key.
+ * @param {any} target Target to extract from.
+ * @param {string|symbol} propertyKey Key in a target.
+ *
+ * @returns {any} Metadata for a key or undefined if metadata is not present.
+ */
+export declare function getReflectMetadata(metadataKey: string, target: any, propertyKey: string | symbol): any;

package/functions/get-words.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Gets words from a string.
+ *
+ * @param {string} x String.
+ *
+ * @returns {Array<string>} Array with the words of provided string.
+ */
+export declare function getWords(x: string): Array<string>;

package/functions/index.d.ts

@@ -0,0 +1,16 @@
+export * from './get-reflect-metadata';
+export * from './get-own-reflect-metadata';
+export * from './get-words';
+export * from './is-arrow-function';
+export * from './is-ctor-function';
+export * from './is-data-view';
+export * from './is-float-32-array';
+export * from './is-float-64-array';
+export * from './is-int-8-array';
+export * from './is-int-16-array';
+export * from './is-int-32-array';
+export * from './is-uint-8-array';
+export * from './is-uint-8-clamped-array';
+export * from './is-uint-16-array';
+export * from './is-uint-32-array';
+export * from './name-of';

package/functions/is-arrow-function.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Checks if value is an arrow function.
+ *
+ * @param {any} x Input value.
+ *
+ * @returns {boolean} True when value is an arrow function. False otherwise.
+ */
+export declare function isArrowFunction(x: any): x is (...args: Array<any>) => any;

package/functions/is-ctor-function.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Checks if value is a constructor function.
+ *
+ * @param {any} x Input value.
+ *
+ * @returns {boolean} True when value is a constructor function. False otherwise.
+ */
+export declare function isCtorFunction(x: any): x is new (...args: Array<any>) => any;

package/functions/is-data-view.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Checks if value is data view.
+ *
+ * @param {any} x Input value.
+ *
+ * @returns {boolean} True when value is data view. False otherwise.
+ */
+export declare function isDataView(x: any): x is DataView;

package/functions/is-float-32-array.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Checks if value is float 32 array.
+ *
+ * @param {any} x Input value.
+ *
+ * @returns {boolean} True when value is float 32 array. False otherwise.
+ */
+export declare function isFloat32Array(x: any): x is Float32Array;

package/functions/is-float-64-array.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Checks if value is float 64 array.
+ *
+ * @param {any} x Input value.
+ *
+ * @returns {boolean} True when value is float 64 array. False otherwise.
+ */
+export declare function isFloat64Array(x: any): x is Float64Array;

package/functions/is-int-16-array.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Checks if value is int 16 array.
+ *
+ * @param {any} x Input value.
+ *
+ * @returns {boolean} True when value is int 16 array. False otherwise.
+ */
+export declare function isInt16Array(x: any): x is Int16Array;

package/functions/is-int-32-array.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Checks if value is int 32 array.
+ *
+ * @param {any} x Input value.
+ *
+ * @returns {boolean} True when value is int 32 array. False otherwise.
+ */
+export declare function isInt32Array(x: any): x is Int32Array;

package/functions/is-int-8-array.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Checks if value is int 8 array.
+ *
+ * @param {any} x Input value.
+ *
+ * @returns {boolean} True when value is int 8 array. False otherwise.
+ */
+export declare function isInt8Array(x: any): x is Int8Array;

package/functions/is-uint-16-array.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Checks if value is uint 16 array.
+ *
+ * @param {any} x Input value.
+ *
+ * @returns {boolean} True when value is uint 16 array. False otherwise.
+ */
+export declare function isUint16Array(x: any): x is Uint16Array;

package/functions/is-uint-32-array.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Checks if value is uint 32 array.
+ *
+ * @param {any} x Input value.
+ *
+ * @returns {boolean} True when value is uint 32 array. False otherwise.
+ */
+export declare function isUint32Array(x: any): x is Uint32Array;

package/functions/is-uint-8-array.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Checks if value is uint 8 array.
+ *
+ * @param {any} x Input value.
+ *
+ * @returns {boolean} True when value is uint 8 array. False otherwise.
+ */
+export declare function isUint8Array(x: any): x is Uint8Array;

package/functions/is-uint-8-clamped-array.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Checks if value is uint 8 clamped array.
+ *
+ * @param {any} x Input value.
+ *
+ * @returns {boolean} True when value is uint 8 clamped array. False otherwise.
+ */
+export declare function isUint8ClampedArray(x: any): x is Uint8ClampedArray;

package/functions/name-of.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Defines name for any value.
+ *
+ * @param {any} x Input value.
+ *
+ * @returns {boolean} Name when present. Unknown otherwise.
+ */
+export declare function nameOf(x: any): string;

package/index.d.ts

@@ -1,22 +1,54 @@
+export * from './factories';
+export * from './functions';
+export * from './injectors';
+export * from './naming-conventions';
+export * from './reference-handlers';
+export * from './serializers';
 export * from './alias';
 export * from './custom-data';
+export * from './default-value-resolver';
 export * from './default-value';
-export * from './deserializable';
 export * from './discriminant';
 export * from './discriminator';
 export * from './factory';
+export * from './generic-argument';
+export * from './generic-metadata';
+export * from './inject-index';
+export * from './inject-metadata';
+export * from './inject-options';
 export * from './inject';
-export * from './injectable';
 export * from './injector';
+export * from './log-level';
+export * from './log';
+export * from './metadata';
 export * from './naming-convention';
-export * from './preserve-discriminator';
+export * from './property-metadata';
+export * from './property-name';
+export * from './property-options';
 export * from './property';
+export * from './reference-callback';
 export * from './reference-handler';
-export * from './serializable';
+export * from './reference-key';
+export * from './reference-value-initializer';
+export * from './reference-value-resolver';
+export * from './reference-value';
+export * from './serializer-context-options';
+export * from './serializer-context';
 export * from './serializer';
-export * from './type-and-property';
+export * from './type-abstraction';
+export * from './type-argument';
+export * from './type-context-entry';
+export * from './type-context';
+export * from './type-ctor';
+export * from './type-fn';
+export * from './type-like';
 export * from './type-manager-options';
 export * from './type-manager';
+export * from './type-metadata-resolver';
+export * from './type-metadata-symbol';
+export * from './type-metadata';
+export * from './type-name';
+export * from './type-options-base';
+export * from './type-options';
+export * from './type-resolver';
 export * from './type';
-export * from './use-default-value';
-export * from './use-implicit-conversion';