@e-mc/types 0.10.1 → 0.10.3

package/LICENSE

@@ -1,11 +1,11 @@
-Copyright 2024 An Pham
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
-
+Copyright 2024 An Pham
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -1,209 +1,209 @@
-# @e-mc/types
-
-* NodeJS 16
-* ES2020
-
-## General Usage
-
-* [Read the Docs](https://e-mc.readthedocs.io)
-
-## Interface
-
-* [View Source](https://www.unpkg.com/@e-mc/types@0.10.1/index.d.ts)
-
-```typescript
-import type { LogArguments } from "./lib/logger";
-
-import type { BytesOptions } from "bytes";
-import type { BinaryLike, CipherGCMTypes, Encoding, RandomUUIDOptions } from "crypto";
-
-function createAbortError(reject: true): Promise<never>;
-function createAbortError(): DOMException;
-function hasBit(value: unknown, flags: number): boolean;
-function ignoreFlag(value: unknown): boolean;
-function cloneFlag(value: unknown): boolean;
-function usingFlag(value: unknown): boolean;
-function watchFlag(value: unknown): boolean;
-function modifiedFlag(value: unknown): boolean;
-function processFlag(value: unknown): boolean;
-function mainFlag(value: unknown): boolean;
-function existsFlag(value: unknown): boolean;
-function getLogCurrent(): LogArguments | null;
-function setLogCurrent(value: LogArguments): void;
-function setTempDir(value: string): boolean;
-function getTempDir(): string;
-function isArray(value: unknown): value is unknown[];
-function isObject(value: unknown): value is object;
-function isPlainObject(value: unknown): value is Record<string | number | symbol, unknown>;
-function isString(value: unknown): value is string;
-function isEmpty(value: unknown): boolean;
-function asFunction(value: unknown, sync?: boolean): ((...args: unknown[]) => Promise<unknown> | unknown) | null;
-function parseTime(value: number | string, start?: number): number;
-function parseExpires(value: number | string, start?: number): number;
-function formatTime(value: number, char: string): string;
-function formatTime(value: number, elapsed?: boolean, char?: string): string;
-function convertTime(value: number | string): number;
-function convertTime(value: HighResolutionTime, format: true): string;
-function convertTime(value: HighResolutionTime, format?: boolean): number;
-function hasGlob(value: string): boolean;
-function escapePattern(value: unknown, lookBehind?: boolean): string;
-function renameExt(value: string, ext: string, when?: string): string;
-function formatSize(value: string): number;
-function formatSize(value: number, options?: BytesOptions): string;
-function alignSize(value: unknown, kb?: number, factor?: number): number;
-function cascadeObject(data: object, query: string, fallback?: unknown): unknown;
-function cloneObject(data: unknown, deep: boolean): unknown;
-function cloneObject(data: unknown, deepIgnore: WeakSet<object>): unknown;
-function cloneObject(data: unknown, options?: CloneObjectOptions<unknown>): unknown;
-function coerceObject(data: unknown, cache: boolean): unknown;
-function coerceObject(data: unknown, parseString?: (...args: [string]) => unknown, cache?: boolean): unknown;
-function getEncoding(value: unknown, fallback?: BufferEncoding): BufferEncoding;
-function encryptUTF8(algorithm: CipherGCMTypes, key: BinaryLike, iv: BinaryLike, data: string, encoding?: Encoding): string | undefined;
-function decryptUTF8(algorithm: CipherGCMTypes, key: BinaryLike, iv: BinaryLike, data: string, encoding?: Encoding): string | undefined;
-function hashKey(data: BinaryLike, algorithm?: string, encoding?: BinaryToTextEncoding): string;
-/** @deprecated - crypto.randomUUID */
-function generateUUID(options?: RandomUUIDOptions): string;
-function incrementUUID(restart?: boolean): string;
-function validateUUID(value: unknown): boolean;
-function randomString(format: string, dictionary?: string): string;
-function errorValue(value: string, hint?: string): Error;
-function errorMessage(title: number | string, value: string, hint?: string): Error;
-function supported(major: number, minor?: number, patch?: number, lts?: boolean): boolean;
-function importESM<T = unknown>(name: string, isDefault?: boolean, fromPath?: boolean): Promise<T>;
-function purgeMemory(percent?: number): number;
-
-interface LOG_TYPE {
-    UNKNOWN: 0;
-    SYSTEM: 1;
-    NODE: 2;
-    PROCESS: 4;
-    COMPRESS: 8;
-    WATCH: 16;
-    FILE: 32;
-    CLOUD: 64;
-    TIME_ELAPSED: 128;
-    TIME_PROCESS: 256;
-    FAIL: 512;
-    HTTP: 1024;
-    IMAGE: 2048;
-    EXEC: 4096;
-    PERMISSION: 8192;
-    TIMEOUT: 16384;
-    STDOUT: 32768;
-    DB: 65536;
-}
-
-interface STATUS_TYPE {
-    UNKNOWN: 0;
-    FATAL: 1;
-    ERROR: 2;
-    WARN: 3;
-    INFO: 4;
-    DEBUG: 5;
-    ASSERT: 6;
-    TRACE: 7;
-}
-
-interface ASSET_FLAG {
-    NONE: 0;
-    IGNORE: 1;
-    CLONE: 2;
-    USING: 4;
-    WATCH: 8;
-    MODIFIED: 16;
-    PROCESS: 32;
-    MAIN: 64;
-    EXISTS: 128;
-}
-
-interface FILE_TYPE {
-    UNKNOWN: 0;
-    ASSET: 1;
-    TRANSFORM: 2;
-    COMPRESSED: 4;
-    SOURCEMAP: 8;
-    TORRENT: 16;
-}
-
-interface ACTION_FLAG {
-    NONE: 0;
-    IGNORE: 1;
-}
-
-interface ERR_CODE {
-    MODULE_NOT_FOUND: "MODULE_NOT_FOUND";
-}
-
-interface DOWNLOAD_TYPE {
-    HTTP: 0;
-    DISK: 1;
-    CACHE: 2;
-}
-
-interface FETCH_TYPE {
-    UNKNOWN: 0;
-    HTTP: 1;
-    TORRENT: 2;
-    FTP: 3;
-    UNIX_SOCKET: 4;
-}
-
-interface DB_TYPE {
-    SQL: 1;
-    NOSQL: 2;
-    DOCUMENT: 4;
-    KEYVALUE: 8;
-}
-
-interface DB_TRANSACTION {
-    ACTIVE: 1;
-    PARTIAL: 2;
-    COMMIT: 4;
-    TERMINATE: 8;
-    ABORT: 16;
-    FAIL: 32;
-    AUTH: 64;
-    CACHE: 128;
-}
-
-interface TRANSFER_TYPE {
-    DISK: 1;
-    STREAM: 2;
-    CHUNK: 4;
-}
-
-interface WATCH_EVENT {
-    MODIFIED: "modified";
-    BROADCAST: "broadcast";
-    CLOSE: "close";
-    ERROR: "error";
-}
-
-interface READDIR_SORT {
-    FILE: number;
-    DIRECTORY: number;
-    DESCENDING: number;
-}
-
-interface THRESHOLD {
-    FILEMANAGER_INTERVAL: number;
-    WATCH_INTERVAL: number;
-    WATCH_CHANGE: number;
-}
-
-const IMPORT_MAP: Record<string, string | undefined>;
-```
-
-## References
-
-- https://www.unpkg.com/@e-mc/types@0.10.1/index.d.ts
-- https://www.unpkg.com/@e-mc/types@0.10.1/lib/logger.d.ts
-- https://www.unpkg.com/@e-mc/types@0.10.1/lib/module.d.ts
-- https://www.unpkg.com/@e-mc/types@0.10.1/lib/object.d.ts
-
-* https://developer.mozilla.org/en-US/docs/Web/API/DOMException
-* https://www.npmjs.com/package/@types/bytes
-
-## LICENSE
-
+# @e-mc/types
+
+* NodeJS 16
+* ES2020
+
+## General Usage
+
+* [Read the Docs](https://e-mc.readthedocs.io)
+
+## Interface
+
+* [View Source](https://www.unpkg.com/@e-mc/types@0.10.3/index.d.ts)
+
+```typescript
+import type { LogArguments } from "./lib/logger";
+
+import type { BytesOptions } from "bytes";
+import type { BinaryLike, CipherGCMTypes, Encoding, RandomUUIDOptions } from "crypto";
+
+function createAbortError(reject: true): Promise<never>;
+function createAbortError(): DOMException;
+function hasBit(value: unknown, flags: number): boolean;
+function ignoreFlag(value: unknown): boolean;
+function cloneFlag(value: unknown): boolean;
+function usingFlag(value: unknown): boolean;
+function watchFlag(value: unknown): boolean;
+function modifiedFlag(value: unknown): boolean;
+function processFlag(value: unknown): boolean;
+function mainFlag(value: unknown): boolean;
+function existsFlag(value: unknown): boolean;
+function getLogCurrent(): LogArguments | null;
+function setLogCurrent(value: LogArguments): void;
+function setTempDir(value: string): boolean;
+function getTempDir(): string;
+function isArray(value: unknown): value is unknown[];
+function isObject(value: unknown): value is object;
+function isPlainObject(value: unknown): value is Record<string | number | symbol, unknown>;
+function isString(value: unknown): value is string;
+function isEmpty(value: unknown): boolean;
+function asFunction(value: unknown, sync?: boolean): ((...args: unknown[]) => unknown) | null;
+function parseTime(value: number | string, start?: number): number;
+function parseExpires(value: number | string, start?: number): number;
+function formatTime(value: number, char: string): string;
+function formatTime(value: number, elapsed?: boolean, char?: string): string;
+function convertTime(value: number | string): number;
+function convertTime(value: HighResolutionTime, format: true): string;
+function convertTime(value: HighResolutionTime, format?: boolean): number;
+function hasGlob(value: string): boolean;
+function escapePattern(value: unknown, lookBehind?: boolean): string;
+function renameExt(value: string, ext: string, when?: string): string;
+function formatSize(value: string): number;
+function formatSize(value: number, options?: BytesOptions): string;
+function alignSize(value: unknown, kb?: number, factor?: number): number;
+function cascadeObject(data: object, query: string, fallback?: unknown): unknown;
+function cloneObject(data: unknown, deep: boolean): unknown;
+function cloneObject(data: unknown, deepIgnore: WeakSet<object>): unknown;
+function cloneObject(data: unknown, options?: CloneObjectOptions<unknown>): unknown;
+function coerceObject(data: unknown, cache: boolean): unknown;
+function coerceObject(data: unknown, parseString?: (...args: [string]) => unknown, cache?: boolean): unknown;
+function getEncoding(value: unknown, fallback?: BufferEncoding): BufferEncoding;
+function encryptUTF8(algorithm: CipherGCMTypes, key: BinaryLike, iv: BinaryLike, data: string, encoding?: Encoding): string | undefined;
+function decryptUTF8(algorithm: CipherGCMTypes, key: BinaryLike, iv: BinaryLike, data: string, encoding?: Encoding): string | undefined;
+function hashKey(data: BinaryLike, algorithm?: string, encoding?: BinaryToTextEncoding): string;
+/** @deprecated - crypto.randomUUID */
+function generateUUID(options?: RandomUUIDOptions): string;
+function incrementUUID(restart?: boolean): string;
+function validateUUID(value: unknown): boolean;
+function randomString(format: string, dictionary?: string): string;
+function errorValue(value: string, hint?: string): Error;
+function errorMessage(title: number | string, value: string, hint?: string): Error;
+function supported(major: number, minor?: number, patch?: number, lts?: boolean): boolean;
+function importESM<T = unknown>(name: string, isDefault?: boolean, fromPath?: boolean): Promise<T>;
+function purgeMemory(percent?: number): number;
+
+interface LOG_TYPE {
+    UNKNOWN: 0;
+    SYSTEM: 1;
+    NODE: 2;
+    PROCESS: 4;
+    COMPRESS: 8;
+    WATCH: 16;
+    FILE: 32;
+    CLOUD: 64;
+    TIME_ELAPSED: 128;
+    TIME_PROCESS: 256;
+    FAIL: 512;
+    HTTP: 1024;
+    IMAGE: 2048;
+    EXEC: 4096;
+    PERMISSION: 8192;
+    TIMEOUT: 16384;
+    STDOUT: 32768;
+    DB: 65536;
+}
+
+interface STATUS_TYPE {
+    UNKNOWN: 0;
+    FATAL: 1;
+    ERROR: 2;
+    WARN: 3;
+    INFO: 4;
+    DEBUG: 5;
+    ASSERT: 6;
+    TRACE: 7;
+}
+
+interface ASSET_FLAG {
+    NONE: 0;
+    IGNORE: 1;
+    CLONE: 2;
+    USING: 4;
+    WATCH: 8;
+    MODIFIED: 16;
+    PROCESS: 32;
+    MAIN: 64;
+    EXISTS: 128;
+}
+
+interface FILE_TYPE {
+    UNKNOWN: 0;
+    ASSET: 1;
+    TRANSFORM: 2;
+    COMPRESSED: 4;
+    SOURCEMAP: 8;
+    TORRENT: 16;
+}
+
+interface ACTION_FLAG {
+    NONE: 0;
+    IGNORE: 1;
+}
+
+interface ERR_CODE {
+    MODULE_NOT_FOUND: "MODULE_NOT_FOUND";
+}
+
+interface DOWNLOAD_TYPE {
+    HTTP: 0;
+    DISK: 1;
+    CACHE: 2;
+}
+
+interface FETCH_TYPE {
+    UNKNOWN: 0;
+    HTTP: 1;
+    TORRENT: 2;
+    FTP: 3;
+    UNIX_SOCKET: 4;
+}
+
+interface DB_TYPE {
+    SQL: 1;
+    NOSQL: 2;
+    DOCUMENT: 4;
+    KEYVALUE: 8;
+}
+
+interface DB_TRANSACTION {
+    ACTIVE: 1;
+    PARTIAL: 2;
+    COMMIT: 4;
+    TERMINATE: 8;
+    ABORT: 16;
+    FAIL: 32;
+    AUTH: 64;
+    CACHE: 128;
+}
+
+interface TRANSFER_TYPE {
+    DISK: 1;
+    STREAM: 2;
+    CHUNK: 4;
+}
+
+interface WATCH_EVENT {
+    MODIFIED: "modified";
+    BROADCAST: "broadcast";
+    CLOSE: "close";
+    ERROR: "error";
+}
+
+interface READDIR_SORT {
+    FILE: number;
+    DIRECTORY: number;
+    DESCENDING: number;
+}
+
+interface THRESHOLD {
+    FILEMANAGER_INTERVAL: number;
+    WATCH_INTERVAL: number;
+    WATCH_CHANGE: number;
+}
+
+const IMPORT_MAP: Record<string, string | undefined>;
+```
+
+## References
+
+- https://www.unpkg.com/@e-mc/types@0.10.3/index.d.ts
+- https://www.unpkg.com/@e-mc/types@0.10.3/lib/logger.d.ts
+- https://www.unpkg.com/@e-mc/types@0.10.3/lib/module.d.ts
+- https://www.unpkg.com/@e-mc/types@0.10.3/lib/object.d.ts
+
+* https://developer.mozilla.org/en-US/docs/Web/API/DOMException
+* https://www.npmjs.com/package/@types/bytes
+
+## LICENSE
+
 BSD 3-Clause