@aitianyu.cn/types 0.0.11 → 0.0.13

package/dist/types/types/TMap.d.ts

@@ -1,80 +1,80 @@
-/**@format */
-import { IComparable } from "./Types";
-/**
- * Tianyu Map
- * Support Customized Object type
- */
-export declare class TMap<K extends IComparable, V> {
-    private _map;
-    private _kMap;
-    /**
-     * Create an empty Tianyu Map Instance
-     */
-    constructor();
-    /**
-     * Clean the Map instance
-     */
-    clear(): void;
-    /**
-     * Delete a specified item from the instance
-     *
-     * @param key The key of the item
-     * @returns return true if deleted successful and return false if failed
-     */
-    delete(key: K): boolean;
-    /**
-     * Executes a provided function once per each key/value pair in the Map, in insertion order.
-     *
-     * @param callbackfn provided execution function
-     * @param thisArg additional args
-     */
-    forEach(callbackfn: (value: V, key: K, map: Map<K, V>) => void, thisArg?: any): void;
-    /**
-     * Returns a specified element from the Map object. If the value that is associated to the provided key is an object,
-     * then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.
-     *
-     * @param key The key of the value
-     * @returns Returns the element associated with the specified key.
-     *          If no element is associated with the specified key, undefined is returned.
-     */
-    get(key: K): V | undefined;
-    /**
-     * Get a boolean value indicates whether an element with the specified key exists or not.
-     *
-     * @param key The key what wants to search
-     * @returns return true if the value is found
-     */
-    has(key: K): boolean;
-    /**
-     * Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.
-     *
-     * @param key The key of new element
-     * @param value The value of new element
-     * @returns return the instance that is current instance
-     */
-    set(key: K, value: V): this;
-    /**
-     * Get a number of elements in the Map
-     *
-     * @returns return the count of elements
-     */
-    size(): number;
-    /**
-     * Get all keys of the Map
-     *
-     * @returns return a keys iterator
-     */
-    keys(): IterableIterator<K>;
-    /**
-     * Get all values of the Map
-     *
-     * @returns return a values iterator
-     */
-    values(): IterableIterator<V>;
-    /**
-     * Get an Iterator of the Map
-     *
-     * @returns return an iterator object
-     */
-    [Symbol.iterator](): Iterator<[K | undefined, V | undefined]>;
-}
+/**@format */
+import { IComparable } from "./Types";
+/**
+ * Tianyu Map
+ * Support Customized Object type
+ */
+export declare class TMap<K extends IComparable, V> {
+    private _map;
+    private _kMap;
+    /**
+     * Create an empty Tianyu Map Instance
+     */
+    constructor();
+    /**
+     * Clean the Map instance
+     */
+    clear(): void;
+    /**
+     * Delete a specified item from the instance
+     *
+     * @param key The key of the item
+     * @returns return true if deleted successful and return false if failed
+     */
+    delete(key: K): boolean;
+    /**
+     * Executes a provided function once per each key/value pair in the Map, in insertion order.
+     *
+     * @param callbackfn provided execution function
+     * @param thisArg additional args
+     */
+    forEach(callbackfn: (value: V, key: K, map: Map<K, V>) => void, thisArg?: any): void;
+    /**
+     * Returns a specified element from the Map object. If the value that is associated to the provided key is an object,
+     * then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.
+     *
+     * @param key The key of the value
+     * @returns Returns the element associated with the specified key.
+     *          If no element is associated with the specified key, undefined is returned.
+     */
+    get(key: K): V | undefined;
+    /**
+     * Get a boolean value indicates whether an element with the specified key exists or not.
+     *
+     * @param key The key what wants to search
+     * @returns return true if the value is found
+     */
+    has(key: K): boolean;
+    /**
+     * Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.
+     *
+     * @param key The key of new element
+     * @param value The value of new element
+     * @returns return the instance that is current instance
+     */
+    set(key: K, value: V): this;
+    /**
+     * Get a number of elements in the Map
+     *
+     * @returns return the count of elements
+     */
+    size(): number;
+    /**
+     * Get all keys of the Map
+     *
+     * @returns return a keys iterator
+     */
+    keys(): IterableIterator<K>;
+    /**
+     * Get all values of the Map
+     *
+     * @returns return a values iterator
+     */
+    values(): IterableIterator<V>;
+    /**
+     * Get an Iterator of the Map
+     *
+     * @returns return an iterator object
+     */
+    [Symbol.iterator](): Iterator<[K | undefined, V | undefined]>;
+}

package/dist/types/types/Types.d.ts

@@ -1,20 +1,25 @@
-/**@format */
-/**A record object type of boolean */
-export type MapOfBoolean = Record<string, boolean>;
-/**A record object type of string array */
-export type MapOfStrings = Record<string, string[]>;
-/**A record object type of string */
-export type MapOfString = Record<string, string>;
-/**A record object type of customized */
-export type MapOfType<T> = Record<string, T>;
-/** no parameter call back function */
-export type CallbackAction = () => void;
-/** call back function with customized type parameter */
-export type CallbackActionT<T> = (value: T) => void;
-/** Tianyu Comparable Interface */
-export interface IComparable {
-    /** Get a string what can indicate the object unified */
-    getString(): string;
-    /** Get a number which is the hash value of the object instance */
-    getHashCode(): number;
-}
+/**@format */
+/**A record object type of boolean */
+export type MapOfBoolean = Record<string, boolean>;
+/**A record object type of string array */
+export type MapOfStrings = Record<string, string[]>;
+/**A record object type of string */
+export type MapOfString = Record<string, string>;
+/**A record object type of customized */
+export type MapOfType<T> = Record<string, T>;
+/** no parameter call back function */
+export type CallbackAction = () => void;
+/** call back function with customized type parameter */
+export type CallbackActionT<T> = (value: T) => void;
+/** A key value pair to include a key and a value */
+export type KeyValuePair<K, V> = {
+    key: K;
+    value: V;
+};
+/** Tianyu Comparable Interface */
+export interface IComparable {
+    /** Get a string what can indicate the object unified */
+    getString(): string;
+    /** Get a number which is the hash value of the object instance */
+    getHashCode(): number;
+}

package/dist/types/types/index.d.ts

@@ -1,9 +1,9 @@
-/**@format */
-export { AreaCode } from "./AreaCode";
-export { Exception } from "./Exception";
-export { LogLevel, type ILog, type IPerfRecorder } from "./Logs";
-export { type IObjectDiffInfo, type ObjectDiffMap } from "./Object";
-export { PathBase } from "./PathBase";
-export { EncryptOption, type ICipher } from "./Security";
-export { TMap } from "./TMap";
-export { type MapOfBoolean, type MapOfStrings, type MapOfString, type MapOfType, type CallbackAction, type CallbackActionT, type IComparable, } from "./Types";
+/**@format */
+export { AreaCode } from "./AreaCode";
+export { Exception } from "./Exception";
+export { LogLevel, type ILog, type IPerfRecorder } from "./Logs";
+export { type IObjectDiffInfo, type ObjectDiffMap } from "./Object";
+export { PathBase } from "./PathBase";
+export { EncryptOption, type ICipher } from "./Security";
+export { TMap } from "./TMap";
+export { type MapOfBoolean, type MapOfStrings, type MapOfString, type MapOfType, type CallbackAction, type CallbackActionT, type IComparable, } from "./Types";

package/dist/types/utilities/coding/Error.d.ts

@@ -1,27 +1,27 @@
-/**@format */
-import { Exception } from "../../types/Exception";
-import { PathTargetType } from "./Path";
-/**
- * Source lost exception of Path Processor.
- * Exception will be thrown if the path is file but the file field is not specified
- */
-export declare class PathProcessorSourceLostException extends Exception {
-    constructor(msg?: string);
-    toString(): string;
-}
-/**
- * Path directory name is not valid.
- * Exception will be thrown if the path name has the invalid char
- */
-export declare class PathDirectoryValidationFailException extends Exception {
-    constructor(msg?: string);
-    toString(): string;
-}
-/**
- * Path is file or directory but target type is not.
- * Exception will be thrown if the path is file(directory) but try to convert to directory(file)
- */
-export declare class PathDirAndFileConvertInvaild extends Exception {
-    constructor(path: string, type: PathTargetType);
-    toString(): string;
-}
+/**@format */
+import { Exception } from "../../types/Exception";
+import { PathTargetType } from "./Path";
+/**
+ * Source lost exception of Path Processor.
+ * Exception will be thrown if the path is file but the file field is not specified
+ */
+export declare class PathProcessorSourceLostException extends Exception {
+    constructor(msg?: string);
+    toString(): string;
+}
+/**
+ * Path directory name is not valid.
+ * Exception will be thrown if the path name has the invalid char
+ */
+export declare class PathDirectoryValidationFailException extends Exception {
+    constructor(msg?: string);
+    toString(): string;
+}
+/**
+ * Path is file or directory but target type is not.
+ * Exception will be thrown if the path is file(directory) but try to convert to directory(file)
+ */
+export declare class PathDirAndFileConvertInvaild extends Exception {
+    constructor(path: string, type: PathTargetType);
+    toString(): string;
+}

package/dist/types/utilities/coding/Path.d.ts

@@ -1,61 +1,61 @@
-/**@format */
-import { PathBase } from "../../types/PathBase";
-import { IComparable } from "../../types/Types";
-/** The target path type */
-export type PathTargetType = "directory" | "file";
-/** Path */
-export declare class Path extends PathBase implements IComparable {
-    private _type;
-    private _file?;
-    /**
-     * Create a new Path instance
-     *
-     * @param dirs the directory names
-     * @param type indicate which type the Path is
-     * @param file the file name if the type is file
-     */
-    constructor(dirs?: string[] | string, type?: PathTargetType, file?: string);
-    /**
-     * Convert the path to a string
-     *
-     * @returns return the string
-     */
-    toString(): string;
-    /**
-     * Set the target type
-     *
-     * @param type new type
-     */
-    setType(type: PathTargetType): void;
-    /**
-     * Get the path type of current instance
-     *
-     * @returns return the path type
-     */
-    getType(): PathTargetType;
-    /**
-     * Set the path file name
-     *
-     * @param file the new file name
-     * @returns return the old file name
-     */
-    setFile(file: string): string | undefined;
-    /**
-     * Get the file name of current instance
-     *
-     * @returns return the file name
-     */
-    getFile(): string | undefined;
-    /**
-     * IComparable impl to get a string what equals to current instance
-     *
-     * @returns return the string
-     */
-    getString(): string;
-    /**
-     * Get a hash code of current instance
-     *
-     * @returns always return 0
-     */
-    getHashCode(): number;
-}
+/**@format */
+import { PathBase } from "../../types/PathBase";
+import { IComparable } from "../../types/Types";
+/** The target path type */
+export type PathTargetType = "directory" | "file";
+/** Path */
+export declare class Path extends PathBase implements IComparable {
+    private _type;
+    private _file?;
+    /**
+     * Create a new Path instance
+     *
+     * @param dirs the directory names
+     * @param type indicate which type the Path is
+     * @param file the file name if the type is file
+     */
+    constructor(dirs?: string[] | string, type?: PathTargetType, file?: string);
+    /**
+     * Convert the path to a string
+     *
+     * @returns return the string
+     */
+    toString(): string;
+    /**
+     * Set the target type
+     *
+     * @param type new type
+     */
+    setType(type: PathTargetType): void;
+    /**
+     * Get the path type of current instance
+     *
+     * @returns return the path type
+     */
+    getType(): PathTargetType;
+    /**
+     * Set the path file name
+     *
+     * @param file the new file name
+     * @returns return the old file name
+     */
+    setFile(file: string): string | undefined;
+    /**
+     * Get the file name of current instance
+     *
+     * @returns return the file name
+     */
+    getFile(): string | undefined;
+    /**
+     * IComparable impl to get a string what equals to current instance
+     *
+     * @returns return the string
+     */
+    getString(): string;
+    /**
+     * Get a hash code of current instance
+     *
+     * @returns always return 0
+     */
+    getHashCode(): number;
+}

package/dist/types/utilities/coding/index.d.ts

@@ -1,3 +1,3 @@
-/**@format */
-export { PathProcessorSourceLostException, PathDirectoryValidationFailException, PathDirAndFileConvertInvaild } from "./Error";
-export { type PathTargetType, Path } from "./Path";
+/**@format */
+export { PathProcessorSourceLostException, PathDirectoryValidationFailException, PathDirAndFileConvertInvaild } from "./Error";
+export { type PathTargetType, Path } from "./Path";

package/dist/types/utilities/core/Errors.d.ts

@@ -1,47 +1,47 @@
-/**@format */
-import { Exception } from "../../types/Exception";
-/** Argument null exception */
-export declare class ArgumentNullOrEmptyException extends Exception {
-    constructor(msg: string);
-    toString(): string;
-}
-/**
- * Object Clone:
- * Function type is not supported.
- * Exception will be thrown if try to clone a function type object
- */
-export declare class ObjectCloneFunctionNotSupportException extends Exception {
-    constructor();
-    toString(): string;
-}
-/**
- * Object Clone:
- * Object different status could not be matched.
- * Exception will be thrown if the object diff could not to be merged
- */
-export declare class ObjectMergeStatusCheckFailedException extends Exception {
-    private status;
-    private path;
-    constructor(path: string, status: "add" | "modify" | "del");
-    toString(): string;
-}
-/**
- * Object Clone:
- * Object different status could not be applied.
- * Exception will be thrown if the object diff could not to be applied
- */
-export declare class ObjectDiffApplyInvalidStatusException extends Exception {
-    private value;
-    constructor(value: any);
-    toString(): string;
-}
-/**
- * Object Clone:
- * Object different merge failed.
- * Exception will be thrown if the object element could not be accessed
- */
-export declare class ObjectDiffMergeFailedException extends Exception {
-    private path;
-    constructor(path: string);
-    toString(): string;
-}
+/**@format */
+import { Exception } from "../../types/Exception";
+/** Argument null exception */
+export declare class ArgumentNullOrEmptyException extends Exception {
+    constructor(msg: string);
+    toString(): string;
+}
+/**
+ * Object Clone:
+ * Function type is not supported.
+ * Exception will be thrown if try to clone a function type object
+ */
+export declare class ObjectCloneFunctionNotSupportException extends Exception {
+    constructor();
+    toString(): string;
+}
+/**
+ * Object Clone:
+ * Object different status could not be matched.
+ * Exception will be thrown if the object diff could not to be merged
+ */
+export declare class ObjectMergeStatusCheckFailedException extends Exception {
+    private status;
+    private path;
+    constructor(path: string, status: "add" | "modify" | "del");
+    toString(): string;
+}
+/**
+ * Object Clone:
+ * Object different status could not be applied.
+ * Exception will be thrown if the object diff could not to be applied
+ */
+export declare class ObjectDiffApplyInvalidStatusException extends Exception {
+    private value;
+    constructor(value: any);
+    toString(): string;
+}
+/**
+ * Object Clone:
+ * Object different merge failed.
+ * Exception will be thrown if the object element could not be accessed
+ */
+export declare class ObjectDiffMergeFailedException extends Exception {
+    private path;
+    constructor(path: string);
+    toString(): string;
+}

package/dist/types/utilities/core/Language.d.ts

@@ -1,17 +1,17 @@
-/**@format */
-import { AreaCode } from "../../types/AreaCode";
-/**
- * Parse area code to general string
- *
- * @param eArea the area code
- * @returns return the general string of specified area code
- */
-export declare function parseAreaCode(eArea: AreaCode): string;
-/**
- * Convert the string to area code
- *
- * @param areaStr the source string
- * @param forceArea a boolean value indicates whether needs to have a strict check for the source string. (That means if in strict mode and the string could not be converted, an unkonwn will be returned.)
- * @returns return the area code
- */
-export declare function parseAreaString(areaStr?: string, forceArea?: boolean): AreaCode;
+/**@format */
+import { AreaCode } from "../../types/AreaCode";
+/**
+ * Parse area code to general string
+ *
+ * @param eArea the area code
+ * @returns return the general string of specified area code
+ */
+export declare function parseAreaCode(eArea: AreaCode): string;
+/**
+ * Convert the string to area code
+ *
+ * @param areaStr the source string
+ * @param forceArea a boolean value indicates whether needs to have a strict check for the source string. (That means if in strict mode and the string could not be converted, an unkonwn will be returned.)
+ * @returns return the area code
+ */
+export declare function parseAreaString(areaStr?: string, forceArea?: boolean): AreaCode;

package/dist/types/utilities/core/Log.d.ts

@@ -1,12 +1,12 @@
-/**@format */
-import { ILog, IPerfRecorder } from "../../types/Logs";
-declare function _startPerf(id?: string): IPerfRecorder;
-declare function _endPerf(recorder: IPerfRecorder, console?: boolean): number;
-/** Tianyu Log Instance */
-export declare const Log: ILog;
-/** Tianyu Performance Instance */
-export declare const Performance: {
-    startPerf: typeof _startPerf;
-    endPerf: typeof _endPerf;
-};
-export {};
+/**@format */
+import { ILog, IPerfRecorder } from "../../types/Logs";
+declare function _startPerf(id?: string): IPerfRecorder;
+declare function _endPerf(recorder: IPerfRecorder, console?: boolean): number;
+/** Tianyu Log Instance */
+export declare const Log: ILog;
+/** Tianyu Performance Instance */
+export declare const Performance: {
+    startPerf: typeof _startPerf;
+    endPerf: typeof _endPerf;
+};
+export {};

package/dist/types/utilities/core/TypeConvertion.d.ts

@@ -1,2 +1,2 @@
-/**@format */
-export declare function getBoolean(value: any): boolean;
+/**@format */
+export declare function getBoolean(value: any): boolean;

package/dist/types/utilities/core/index.d.ts

@@ -1,6 +1,6 @@
-/**@format */
-export { ArgumentNullOrEmptyException, ObjectCloneFunctionNotSupportException, ObjectMergeStatusCheckFailedException, ObjectDiffApplyInvalidStatusException, ObjectDiffMergeFailedException, } from "./Errors";
-export { parseAreaCode, parseAreaString } from "./Language";
-export { Log, Performance } from "./Log";
-export { ObjectCalculater } from "./object/Calculater";
-export { ObjectHelper } from "./object/Helper";
+/**@format */
+export { ArgumentNullOrEmptyException, ObjectCloneFunctionNotSupportException, ObjectMergeStatusCheckFailedException, ObjectDiffApplyInvalidStatusException, ObjectDiffMergeFailedException, } from "./Errors";
+export { parseAreaCode, parseAreaString } from "./Language";
+export { Log, Performance } from "./Log";
+export { ObjectCalculater } from "./object/Calculater";
+export { ObjectHelper } from "./object/Helper";

package/dist/types/utilities/core/interface/ITJSON.d.ts

@@ -0,0 +1,5 @@
+/** @format */
+import { IComparable } from "../../../../src/types/Types";
+export interface ITianyuJSON extends IComparable {
+    toString(): string;
+}

package/dist/types/utilities/core/interface/ITianyuType.d.ts

@@ -0,0 +1,5 @@
+/** @format */
+import { IComparable } from "../../../../src/types/Types";
+export interface ITianyuType extends IComparable {
+    toString(): string;
+}

package/dist/types/utilities/core/object/ArrayHelper.d.ts

@@ -1,11 +1,11 @@
-/**@format */
-/** Array type related tools */
-export declare class ArrayHelper {
-    /**
-     * To merge multiple arrays into a new array and remove duplicated elements.
-     *
-     * @param {any[]} array arrays
-     * @returns return a new array
-     */
-    static merge(...array: any[]): any[];
-}
+/**@format */
+/** Array type related tools */
+export declare class ArrayHelper {
+    /**
+     * To merge multiple arrays into a new array and remove duplicated elements.
+     *
+     * @param {any[]} array arrays
+     * @returns return a new array
+     */
+    static merge(...array: any[]): any[];
+}