@e-mc/module 0.9.7 → 0.10.0

package/README.md

@@ -9,7 +9,7 @@
 
 ## Interface
 
-* [View Source](https://www.unpkg.com/@e-mc/types@0.9.7/lib/index.d.ts)
+* [View Source](https://www.unpkg.com/@e-mc/types@0.10.0/lib/index.d.ts)
 
 ```typescript
 import type { LogStatus } from "./squared";
@@ -17,15 +17,14 @@ import type { LogStatus } from "./squared";
 import type { IHost } from "./index";
 import type { IAbortComponent, IPermission } from "./core";
 import type { LOG_TYPE, STATUS_TYPE, ExecCommand, LogArguments, LogComponent, LogDate, LogFailOptions, LogMessageOptions, LogOptions, LogProcessOptions, LogTime, LogType, LogValue, LoggerFormat, StatusType } from "./logger";
-import type { AsHashOptions, CheckSemVerOptions, CopyDirOptions, CopyDirResult, CopyFileOptions, CreateDirOptions, DeleteFileOptions, GetTempDirOptions, MoveFileOptions, NormalizeFlags, ParseFunctionOptions, PermissionOptions, ProtocolType, ReadBufferOptions, ReadFileCallback, ReadFileOptions, ReadHashOptions, ReadTextOptions, RemoveDirOptions, WriteFileOptions } from "./module";
+import type { AsHashOptions, CheckSemVerOptions, CopyDirOptions, CopyDirResult, CopyFileOptions, CreateDirOptions, DeleteFileOptions, MoveFileOptions, ParseFunctionOptions, PermissionOptions, ProtocolType, ReadBufferOptions, ReadFileCallback, ReadFileOptions, ReadHashOptions, ReadTextOptions, RemoveDirOptions, TempDirOptions, WriteFileOptions } from "./module";
 import type { Settings } from "./node";
 import type { LoggerFormatSettings } from "/settings";
 
 import type { SpawnOptions } from "child_process";
-import type { BinaryLike } from "crypto";
+import type { BinaryLike, HashOptions } from "crypto";
 import type { FileTypeResult } from "file-type";
 import type { NoParamCallback } from "fs";
-
 import type * as EventEmitter from "events";
 
 type BufferView = Buffer | string | NodeJS.ArrayBufferView;
@@ -34,9 +33,10 @@ type CpuUsage = NodeJS.CpuUsage;
 interface IModule extends EventEmitter, IAbortComponent {
     readonly status: LogStatus<StatusType>[];
     readonly errors: unknown[];
+    /** @deprecated Types.supported */
     supported(major: number, minor?: number, patch?: number, lts?: boolean): boolean;
     supports(name: string, value?: boolean): boolean;
-    getTempDir(options: GetTempDirOptions): string;
+    getTempDir(options: TempDirOptions): string;
     getTempDir(uuidDir: boolean, createDir: boolean): string;
     getTempDir(pathname: string, createDir: boolean): string;
     getTempDir(uuidDir: boolean, filename?: string, createDir?: boolean): string;
@@ -119,6 +119,8 @@ interface IModule extends EventEmitter, IAbortComponent {
     get sessionId(): string;
     set broadcastId(value);
     get broadcastId(): string | string[];
+    set silent(value);
+    get silent(): boolean;
     get logType(): LOG_TYPE;
     set logLevel(value: number | string);
     get logLevel(): number;
@@ -168,8 +170,10 @@ interface ModuleConstructor {
     readonly LOG_TYPE: LOG_TYPE;
     readonly LOG_FORMAT: LoggerFormatSettings<LoggerFormat<number>>;
     readonly STATUS_TYPE: STATUS_TYPE;
+    readonly PLATFORM_WIN32: boolean;
     readonly MAX_TIMEOUT: number;
     readonly TEMP_DIR: string;
+    /** @deprecated Types.supported */
     supported(major: number, minor?: number, patch?: number, lts?: boolean): boolean;
     formatMessage(type: LogType, title: string, value: LogValue, message?: unknown, options?: LogMessageOptions): void;
     writeFail(value: LogValue, message?: unknown, options?: LogFailOptions | LogType): void;
@@ -177,8 +181,9 @@ interface ModuleConstructor {
     parseFunction(value: unknown, options?: ParseFunctionOptions): ((...args: unknown[]) => Promise<unknown> | unknown) | null;
     parseFunction(value: unknown, absolute: boolean, sync?: boolean): ((...args: unknown[]) => Promise<unknown> | unknown) | null;
     asString(value: unknown, cacheKey?: boolean | "throws"): string;
-    asHash(data: BinaryLike, options: AsHashOptions): string;
-    asHash(data: BinaryLike, algorithm?: unknown, digest?: unknown): string;
+    asHash(data: BinaryLike, options?: AsHashOptions): string;
+    asHash(data: BinaryLike, algorithm?: string, options?: AsHashOptions): string;
+    asHash(data: BinaryLike, algorithm?: string, digest?: BinaryToTextEncoding): string;
     readHash(value: string | URL, options?: ReadHashOptions): Promise<string>;
     toPosix(value: unknown, normalize: boolean): string;
     toPosix(value: unknown, filename?: string, normalize?: boolean): string;
@@ -194,7 +199,7 @@ interface ModuleConstructor {
     resolvePath(value: string, base: string | URL): string;
     joinPath(...values: [...paths: unknown[], normalize: boolean][]): string;
     joinPath(...values: unknown[]): string;
-    normalizePath(value: unknown, flags?: boolean | NormalizeFlags): string;
+    normalizePath(value: unknown, flags?: boolean | number): string;
     createDir(value: string | URL, overwrite?: boolean): boolean;
     removeDir(value: string | URL, sinceCreated: number, recursive?: boolean): boolean;
     removeDir(value: string | URL, empty?: boolean, recursive?: boolean): boolean;
@@ -238,10 +243,9 @@ interface ModuleConstructor {
 ## Settings
 
 ```typescript
-import type { LogMessageOptions, LogTypeValue, LoggerStatus } from "./logger";
+import type { BackgroundColor, ForegroundColor, LogMessageOptions, LogTypeValue, LoggerProgress, LoggerStatus } from "./logger";
 import type { LoggerProcessSettings } from "./settings";
 
-import type { BackgroundColor as IBackgroundColor, ForegroundColor as IForegroundColor } from "chalk";
 import type { BinaryLike, CipherGCMTypes } from "crypto";
 import type { SecureVersion } from "tls";
 
@@ -297,6 +301,7 @@ interface ErrorModule {
 
 interface TempModule {
     dir?: string;
+    env?: string;
     write?: boolean;
 }
 
@@ -311,6 +316,7 @@ interface LoggerModule {
             bg_color?: BackgroundColor;
             bold?: boolean;
             justify?: "left" | "center" | "right";
+            braces?: string;
             as?: StringMap;
         };
         value?: {
@@ -325,6 +331,7 @@ interface LoggerModule {
             color?: ForegroundColor;
             bg_color?: BackgroundColor;
             bold?: boolean;
+            braces?: [string, string];
             as?: StringMap;
             unit?: "auto" | "s" | "ms";
         };
@@ -333,6 +340,7 @@ interface LoggerModule {
             color?: ForegroundColor;
             bg_color?: BackgroundColor;
             bold?: boolean;
+            braces?: [string, string];
         };
         meter?: {
             color?: ForegroundColor;
@@ -340,6 +348,12 @@ interface LoggerModule {
             bg_alt_color?: BackgroundColor;
             bold?: boolean;
         };
+        error?: {
+            color?: ForegroundColor;
+            alt_color?: ForegroundColor;
+            bg_color?: BackgroundColor;
+            braces?: [string, string];
+        };
     };
     meter?: {
         http?: number;
@@ -365,6 +379,7 @@ interface LoggerModule {
     stdout?: boolean;
     abort?: boolean;
     status?: boolean | LoggerStatus;
+    progress?: LoggerProgress;
     unknown?: boolean | LoggerColor;
     system?: boolean | LoggerColor;
     process?: boolean | LoggerProcessSettings;
@@ -382,18 +397,15 @@ interface LoggerModule {
     session_id?: boolean | number;
     stack_trace?: boolean | number;
 }
-
-type BackgroundColor = typeof IBackgroundColor | `#${string}`;
-type ForegroundColor = typeof IForegroundColor | `#${string}`;
 ```
 
 ## References
 
-- https://www.unpkg.com/@e-mc/types@0.9.7/lib/core.d.ts
-- https://www.unpkg.com/@e-mc/types@0.9.7/lib/logger.d.ts
-- https://www.unpkg.com/@e-mc/types@0.9.7/lib/module.d.ts
-- https://www.unpkg.com/@e-mc/types@0.9.7/lib/node.d.ts
-- https://www.unpkg.com/@e-mc/types@0.9.7/lib/settings.d.ts
+- https://www.unpkg.com/@e-mc/types@0.10.0/lib/core.d.ts
+- https://www.unpkg.com/@e-mc/types@0.10.0/lib/logger.d.ts
+- https://www.unpkg.com/@e-mc/types@0.10.0/lib/module.d.ts
+- https://www.unpkg.com/@e-mc/types@0.10.0/lib/node.d.ts
+- https://www.unpkg.com/@e-mc/types@0.10.0/lib/settings.d.ts
 
 * https://www.npmjs.com/package/@types/node
 

package/index.d.ts

@@ -1,5 +1,5 @@
-import type { ModuleConstructor } from '../types/lib';
-
-declare const Module: ModuleConstructor;
-
+import type { ModuleConstructor } from '../types/lib';
+
+declare const Module: ModuleConstructor;
+
 export = Module;