0.10.3 • Published 9 months ago

@e-mc/types v0.10.3

Weekly downloads
-
License
BSD-3-Clause
Repository
github
Last release
9 months ago

@e-mc/types

  • NodeJS 16
  • ES2020

General Usage

Interface

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

LICENSE

BSD 3-Clause

0.5.10

12 months ago

0.5.11

11 months ago

0.5.16

9 months ago

0.5.14

9 months ago

0.5.15

9 months ago

0.5.12

10 months ago

0.5.13

9 months ago

0.9.8

10 months ago

0.7.11

11 months ago

0.9.7

11 months ago

0.7.10

12 months ago

0.7.13

10 months ago

0.9.9

10 months ago

0.7.12

10 months ago

0.9.4

12 months ago

0.5.8

12 months ago

0.9.3

1 year ago

0.5.7

1 year ago

0.9.6

11 months ago

0.5.9

12 months ago

0.9.5

12 months ago

0.7.15

9 months ago

0.7.14

9 months ago

0.7.17

9 months ago

0.7.16

9 months ago

0.10.1

10 months ago

0.10.2

9 months ago

0.10.3

9 months ago

0.10.0

11 months ago

0.9.12

9 months ago

0.9.13

9 months ago

0.6.7

12 months ago

0.6.6

12 months ago

0.9.10

9 months ago

0.6.9

10 months ago

0.9.11

9 months ago

0.6.8

11 months ago

0.6.10

10 months ago

0.6.12

9 months ago

0.6.11

9 months ago

0.6.14

9 months ago

0.6.13

9 months ago

0.9.2

1 year ago

0.7.9

12 months ago

0.8.21

9 months ago

0.7.8

12 months ago

0.8.20

9 months ago

0.7.7

1 year ago

0.8.12

12 months ago

0.8.11

1 year ago

0.8.14

12 months ago

0.8.13

12 months ago

0.8.19

9 months ago

0.8.16

10 months ago

0.8.15

11 months ago

0.8.18

9 months ago

0.8.17

10 months ago

0.6.5

12 months ago

0.6.4

1 year ago

0.8.9

1 year ago

0.8.8

1 year ago

0.7.6

1 year ago

0.7.5

1 year ago

0.8.10

1 year ago

0.6.3

1 year ago

0.7.4

1 year ago

0.5.6

1 year ago

0.9.1

1 year ago

0.9.0

1 year ago

0.8.7

1 year ago

0.6.2

1 year ago

0.7.3

1 year ago

0.5.5

1 year ago

0.8.6

1 year ago

0.7.2

1 year ago

0.5.4

1 year ago

0.6.1

1 year ago

0.8.5

1 year ago

0.8.4

1 year ago

0.8.3

1 year ago

0.8.2

1 year ago

0.8.1

1 year ago

0.8.0

2 years ago

0.7.1

2 years ago

0.7.0

2 years ago

0.6.0

2 years ago

0.5.3

2 years ago

0.5.2

2 years ago

0.5.1

2 years ago

0.5.0

2 years ago

0.4.2

2 years ago

0.4.1

2 years ago

0.4.0

2 years ago

0.3.3

2 years ago

0.3.2

2 years ago

0.3.1

2 years ago

0.3.0

2 years ago

0.2.0

2 years ago

0.1.0

2 years ago

0.0.4

2 years ago

0.0.3

2 years ago

0.0.2

2 years ago

0.0.1

2 years ago