@aitianyu.cn/types 0.0.13 → 0.1.1

package/dist/types/{utilities/coding → 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/core → 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 → 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 → 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 → 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 → core}/interface/ITJSON.d.ts

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

package/dist/types/{utilities/core → core}/interface/ITianyuType.d.ts

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

package/dist/types/{utilities/core → 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[];
+}

package/dist/types/core/object/Bytes.d.ts

@@ -0,0 +1,13 @@
+/** @format */
+/// <reference types="node" />
+/// <reference types="node" />
+/** Bytes Object type */
+export declare class Bytes {
+    /**
+     * Get a bytes buffer filled with random data
+     *
+     * @param size the length of bytes buffer
+     * @returns buffer
+     */
+    static random(size: number): Buffer;
+}

package/dist/types/{utilities/core → core}/object/Calculater.d.ts

@@ -1,22 +1,22 @@
-/**@format */
-import { ObjectDiffMap } from "../../../types/Object";
-/** Object Calculation Manager of Tianyu to provide data changes delta calculation and merge */
-export declare class ObjectCalculater {
-    /**
-     * Compare two objects and get the delta changes between the two objects
-     *
-     * @param previous the previous object
-     * @param newest the newest object
-     * @returns return the defferents map
-     */
-    static calculateDiff(previous: any, newest: any): ObjectDiffMap;
-    /**
-     * Merge the object value status from one to another one following with the object different maps
-     *
-     * @param value the raw value(status)
-     * @param diffs the value changed status map array, contains multiply status maps and the status merge will be one by one.
-     * @param strict a boolean value used to whether the program needs a strict status check to avoid some data errors
-     * @returns return a new value status
-     */
-    static mergeDiff(value: any, diffs: ObjectDiffMap[], strict?: boolean): any;
-}
+/**@format */
+import { ObjectDiffMap } from "../../types/Object";
+/** Object Calculation Manager of Tianyu to provide data changes delta calculation and merge */
+export declare class ObjectCalculater {
+    /**
+     * Compare two objects and get the delta changes between the two objects
+     *
+     * @param previous the previous object
+     * @param newest the newest object
+     * @returns return the defferents map
+     */
+    static calculateDiff(previous: any, newest: any): ObjectDiffMap;
+    /**
+     * Merge the object value status from one to another one following with the object different maps
+     *
+     * @param value the raw value(status)
+     * @param diffs the value changed status map array, contains multiply status maps and the status merge will be one by one.
+     * @param strict a boolean value used to whether the program needs a strict status check to avoid some data errors
+     * @returns return a new value status
+     */
+    static mergeDiff(value: any, diffs: ObjectDiffMap[], strict?: boolean): any;
+}

package/dist/types/core/object/DataView.d.ts

@@ -0,0 +1,11 @@
+/** @format */
+/** DataView Object Type */
+export declare class DataView {
+    /**
+     * Create a new node:DataView from given data buffer
+     *
+     * @param data source data buffer
+     * @returns return node:DataView type equals to given data buffer
+     */
+    static parse(data: ArrayBuffer | Int8Array | Uint8Array | Uint8ClampedArray): globalThis.DataView;
+}

package/dist/types/core/object/Integer.d.ts

@@ -0,0 +1,71 @@
+/** @format */
+/** Integer Object Type */
+export declare class Integer {
+    /**
+     * Get a random integer between min value and max value.
+     * min value should greater than 0, max value should less than 2^48-1 (281474976710655)
+     *
+     * @param min the min value (0 will be applied when not given)
+     * @param max the max value (281474976710655 will be applied when not given)
+     * @returns return the random value
+     */
+    static random(min?: number, max?: number): number;
+    /**
+     * convert source number to be a 8-byte array
+     *
+     * @param srcValue source value
+     * @returns return a 8-byte array
+     */
+    static toBytes(srcValue: number): number[];
+    /**
+     * number left shift
+     * times will be calculated to get the end 6-bit at the beginning to avoid over-flow
+     *
+     * @param value source value
+     * @param times left shift steps
+     * @returns return result value
+     */
+    static left(value: number, times: number): number;
+    /**
+     * number right shift
+     * times will be calculated to get the end 6-bit at the beginning to avoid over-flow
+     *
+     * @param value source value
+     * @param times right shift steps
+     * @returns return result value
+     */
+    static right(value: number, times: number): number;
+    /**
+     * number unsigned right shift
+     * times will be calculated to get the end 6-bit at the beginning to avoid over-flow
+     *
+     * @param value source value
+     * @param times right shift steps
+     * @returns return result value
+     */
+    static rightUnsigned(value: number, times: number): number;
+    /**
+     * or
+     *
+     * @param value1 the first value
+     * @param values the following values array
+     * @returns return calculated value
+     */
+    static or(value1: number, ...values: number[]): number;
+    /**
+     * and
+     *
+     * @param value1 the first value
+     * @param values the following values array
+     * @returns return calculated value
+     */
+    static and(value1: number, ...values: number[]): number;
+    /**
+     * xor
+     *
+     * @param value1 the first value
+     * @param value2 the second value
+     * @returns return calculated value
+     */
+    static xor(value1: number, value2: number): number;
+}

package/dist/types/core/object/Json.d.ts

@@ -0,0 +1,22 @@
+/** @format */
+/** Json Lib */
+export declare class Json {
+    /**
+     * @deprecated
+     *
+     * convert a string to be a javascript object.
+     * This is an unsafe function to convert a string to be object. suggest to use parseSafe to convert string to object.
+     *
+     * @param src source string
+     * @returns target js-object
+     */
+    static parse(src: string): any;
+    /**
+     * convert a string to be a javascript object safty
+     *
+     * @param src source string
+     * @param failed value returned when converted failed, default is null
+     * @returns target js-object
+     */
+    static parseSafe(src: string, failed?: any): any | null;
+}

package/dist/types/{utilities/core/object/Helper.d.ts → core/object/ObjectHelper.d.ts}

@@ -1,39 +1,39 @@
-/**@format */
-/** Object Helper of Tianyu to provide data type checking, objects comparing, validation, data clone and other functions */
-export declare class ObjectHelper {
-    /**
-     * check whether the specified value does extend from nodejs native type
-     *
-     * @param {any} value supported value type of tianyu store
-     * @returns {boolean} return true if the value is based on type number, string, boolean, function, otherwise false
-     */
-    static isSimpleDataType(value: any): boolean;
-    /**
-     * get a deep copy from source
-     *
-     * @param {any} sources the specified source value
-     * @returns {any} return a new value that is independent from sources
-     */
-    static clone(source: any): any;
-    private static _clone;
-    private static _cloneArray;
-    private static _cloneRecordType;
-    /**
-     * Check the object whether can be stringified
-     *
-     * @param obj be checked object
-     * @returns return true is valid, otherwise false
-     */
-    static validateSerializable(obj: any): boolean;
-    /**
-     * Compare two or more objects are the same or different
-     *
-     * @param objs the objects which need to be compared
-     * @returns same - if all the objects are same, different - if at least one object is not same to other objects
-     * @description if there are only one parameter or no parameter is provided, same result will be returned
-     */
-    static compareObjects(...objs: any): "same" | "different";
-    private static _compareSimpleType;
-    private static _compareArrayType;
-    private static _compareObjectType;
-}
+/**@format */
+/** Object Helper of Tianyu to provide data type checking, objects comparing, validation, data clone and other functions */
+export declare class ObjectHelper {
+    /**
+     * check whether the specified value does extend from nodejs native type
+     *
+     * @param {any} value supported value type of tianyu store
+     * @returns {boolean} return true if the value is based on type number, string, boolean, function, otherwise false
+     */
+    static isSimpleDataType(value: any): boolean;
+    /**
+     * get a deep copy from source
+     *
+     * @param {any} sources the specified source value
+     * @returns {any} return a new value that is independent from sources
+     */
+    static clone(source: any): any;
+    private static _clone;
+    private static _cloneArray;
+    private static _cloneRecordType;
+    /**
+     * Check the object whether can be stringified
+     *
+     * @param obj be checked object
+     * @returns return true is valid, otherwise false
+     */
+    static validateSerializable(obj: any): boolean;
+    /**
+     * Compare two or more objects are the same or different
+     *
+     * @param objs the objects which need to be compared
+     * @returns same - if all the objects are same, different - if at least one object is not same to other objects
+     * @description if there are only one parameter or no parameter is provided, same result will be returned
+     */
+    static compareObjects(...objs: any): "same" | "different";
+    private static _compareSimpleType;
+    private static _compareArrayType;
+    private static _compareObjectType;
+}

package/dist/types/core/object/StringHelper.d.ts

@@ -0,0 +1,21 @@
+/**@format */
+export declare class StringHelper {
+    static format(source: string, args?: (string | number)[] | string): string;
+    /**
+     * @deprecated
+     *
+     * convert an object to be a string.
+     * This is an unsafe function to convert an object to be string. suggest to use stringifySafe to convert object to string.
+     *
+     * @param src source object
+     * @returns target string
+     */
+    static stringify(data: any): string;
+    /**
+     * convert an object to be a string safty. empty string will be return when error occurs in converting
+     *
+     * @param src source object
+     * @returns target string
+     */
+    static stringifySafe(data: any): string;
+}

package/dist/types/{utilities/core → core}/type/TArray.d.ts

@@ -1,3 +1,3 @@
-/** @format */
-export declare class TArray<T> {
-}
+/** @format */
+export declare class TArray<T> {
+}

package/dist/types/{utilities/core → core}/type/TBoolean.d.ts

@@ -1,3 +1,3 @@
-/** @format */
-export declare class TBoolean {
-}
+/** @format */
+export declare class TBoolean {
+}

package/dist/types/{utilities/core → core}/type/TJSON.d.ts

@@ -1,3 +1,3 @@
-/** @format */
-export declare class TJSON {
-}
+/** @format */
+export declare class TJSON {
+}

package/dist/types/{utilities/core → core}/type/TNumber.d.ts

@@ -1,3 +1,3 @@
-/** @format */
-export declare class TNumber {
-}
+/** @format */
+export declare class TNumber {
+}

package/dist/types/{utilities/core → core}/type/TObject.d.ts

@@ -1,3 +1,3 @@
-/** @format */
-export declare class TObject {
-}
+/** @format */
+export declare class TObject {
+}

package/dist/types/{utilities/core → core}/type/TString.d.ts

@@ -1,3 +1,3 @@
-/** @format */
-export declare class TString {
-}
+/** @format */
+export declare class TString {
+}