@e-mc/types 0.10.2 → 0.10.3

package/README.md

@@ -9,7 +9,7 @@
 
 ## Interface
 
-* [View Source](https://www.unpkg.com/@e-mc/types@0.10.2/index.d.ts)
+* [View Source](https://www.unpkg.com/@e-mc/types@0.10.3/index.d.ts)
 
 ```typescript
 import type { LogArguments } from "./lib/logger";
@@ -37,7 +37,7 @@ 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 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;
@@ -196,10 +196,10 @@ const IMPORT_MAP: Record<string, string | undefined>;
 
 ## References
 
-- https://www.unpkg.com/@e-mc/types@0.10.2/index.d.ts
-- https://www.unpkg.com/@e-mc/types@0.10.2/lib/logger.d.ts
-- https://www.unpkg.com/@e-mc/types@0.10.2/lib/module.d.ts
-- https://www.unpkg.com/@e-mc/types@0.10.2/lib/object.d.ts
+- 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

package/constant.d.ts

@@ -1,5 +1,5 @@
 export const enum INTERNAL {
-    VERSION = '0.10.2',
+    VERSION = '0.10.3',
     TEMP_DIR = 'tmp',
     CJS = '__cjs__'
 }

package/index.d.ts

@@ -298,7 +298,7 @@ declare namespace types {
     function isPlainObject<T = PlainObject>(value: unknown): value is T;
     function isString(value: unknown): value is string;
     function isEmpty(value: unknown): boolean;
-    function asFunction<T = unknown, U = FunctionType<Promise<T> | T>>(value: unknown, sync?: boolean): Null<U>;
+    function asFunction<U = unknown, V = unknown>(value: unknown, sync?: boolean): Null<FunctionType<U, V>>;
     function parseTime(value: number | string, start?: number): number;
     function parseExpires(value: number | string, start?: number): number;
     function formatTime(value: number, char: string): string;

package/lib/index.d.ts

@@ -13,9 +13,9 @@ import type { AssetContentOptions, ChecksumOptions, DeleteFileAddendum, FileOutp
 import type { HttpAgentSettings, HttpProtocolVersion, HttpRequestClient, InternetProtocolVersion } from './http';
 import type { CommandData, CropData, QualityData, ResizeData, RotateData, TransformOptions } from './image';
 import type { ExecCommand, LOG_TYPE, LogArguments, LogComponent, LogDate, LogFailOptions, LogMessageOptions, LogOptions, LogProcessOptions, LogState, LogTime, LogType, LogValue, STATUS_TYPE, StatusType } from './logger';
-import type { AsHashOptions, CheckSemVerOptions, CopyDirOptions, CopyDirResult, CopyFileOptions, CreateDirOptions, DeleteFileOptions, FileTypeFormat, MoveFileOptions, ParseFunctionOptions, PermissionOptions, ProtocolType, ReadBufferOptions, ReadFileCallback, ReadFileOptions, ReadHashOptions, ReadTextOptions, RemoveDirOptions, TempDirOptions, WriteFileOptions } from './module';
+import type { AsHashOptions, CheckSemVerOptions, CopyDirOptions, CopyDirResult, CopyFileOptions, CreateDirOptions, DeleteFileOptions, FileTypeFormat, GlobDirOptions, MoveFileOptions, ParseFunctionOptions, PermissionOptions, ProtocolType, ReadBufferOptions, ReadFileCallback, ReadFileOptions, ReadHashOptions, ReadTextOptions, RemoveDirOptions, TempDirOptions, WriteFileOptions } from './module';
 import type { RequestData, Settings } from './node';
-import type { ApplyOptions, Aria2Options, BufferFormat, DataEncodedResult, DataObjectResult, FormDataPart, HeadersOnCallback, HostConfig, OpenOptions, PostOptions, ProxySettings, ReadExpectType, RequestInit, StatusOnCallback } from './request';
+import type { ApplyOptions, Aria2Options, BufferFormat, DataEncodedResult, DataObjectResult, FormDataPart, HeadersOnCallback, HostConfig, OpenOptions, PostOptions, ProxySettings, PutOptions, ReadExpectType, RequestInit, StatusOnCallback } from './request';
 import type { ClientModule, CloudAuthSettings, CloudModule, CloudServiceOptions, CompressModule, CompressSettings, DbCoerceSettings, DbModule, DbSourceOptions, DnsLookupSettings, DocumentComponent, DocumentComponentOption, DocumentModule, HandlerSettings, HttpConnectSettings, HttpMemorySettings, ImageModule, LoggerFormat, LoggerFormatSettings, PoolConfig, RequestModule, RequestSettings, TaskModule, WatchModule } from './settings';
 import type { Command, SpawnResult } from './task';
 import type { IFileGroup, ModifiedPostFinalizeListener, SecureOptions, WatchInitResult } from './watch';
@@ -28,12 +28,12 @@ import type { LookupFunction } from 'net';
 import type { Readable, Writable } from 'stream';
 import type { SecureContextOptions } from 'tls';
 import type { BrotliCompress, Gzip } from 'zlib';
+// @ts-ignore
+import type { FileTypeResult } from 'file-type';
 
 import type * as EventEmitter from 'events';
-
 // @ts-ignore
 import type * as ws from 'ws';
-import type { FileTypeResult } from 'file-type';
 
 type BufferView = Bufferable | NodeJS.ArrayBufferView;
 type CpuUsage = NodeJS.CpuUsage;
@@ -327,6 +327,9 @@ declare namespace functions {
         opts(url: string | URL, options?: OpenOptions): HostConfig;
         open(uri: string | URL, options: OpenOptions): HttpRequestClient;
         head(uri: string | URL, options?: OpenOptions): ClientRequest;
+        put<V extends { format: undefined; encoding: undefined }>(uri: string | URL, data: unknown, contentType: string): Promise<DataObjectResult<V>>;
+        put<V extends PutOptions>(uri: string | URL, data: unknown, options: V): Promise<DataObjectResult<V>>;
+        put<V extends PutOptions>(uri: string | URL, data: unknown, contentType?: string | V, options?: V): Promise<DataObjectResult<V>>;
         post<V extends { format: undefined; encoding: undefined }>(uri: string | URL, data: unknown, contentType: string): Promise<DataObjectResult<V>>;
         post<V extends { format: undefined; encoding: undefined }>(uri: string | URL, parts: FormDataPart[]): Promise<DataObjectResult<V>>;
         post<V extends { format: undefined; encoding: undefined }>(uri: string | URL, form: AnyObject, parts: FormDataPart[]): Promise<DataObjectResult<V>>;
@@ -726,8 +729,8 @@ declare namespace functions {
         formatMessage(type: LogType, title: string, value: LogValue, message?: unknown, options?: LogMessageOptions): void;
         writeFail(value: LogValue, message?: unknown, options?: LogFailOptions | LogType): void;
         enabled(key: string, username?: string): boolean;
-        parseFunction<U = unknown>(value: unknown, options?: ParseFunctionOptions): Null<FunctionType<Promise<U> | U>>;
-        parseFunction<U = unknown>(value: unknown, absolute: boolean, sync?: boolean): Null<FunctionType<Promise<U> | U>>;
+        parseFunction<U = unknown, V = unknown>(value: unknown, options?: ParseFunctionOptions): Null<FunctionType<Promise<U> | U, V>>;
+        parseFunction<U = unknown, V = unknown>(value: unknown, absolute: boolean, sync?: boolean): Null<FunctionType<Promise<U> | U, V>>;
         asString(value: unknown, cacheKey?: boolean | "throws"): string;
         asHash(data: BinaryLike, options?: AsHashOptions): string;
         asHash(data: BinaryLike, algorithm?: string, options?: HashOptions): string;
@@ -753,6 +756,8 @@ declare namespace functions {
         removeDir(value: string | URL, empty?: boolean, recursive?: boolean): boolean;
         copyDir(src: string | URL, dest: string | URL, move?: boolean, recursive?: boolean): Promise<CopyDirResult>;
         copyDir(src: string | URL, dest: string | URL, options?: CopyDirOptions): Promise<CopyDirResult>;
+        globDir(src: string | URL, pattern: ArrayOf<string>, recursive: boolean | number): Promise<string[]>;
+        globDir(src: string | URL, pattern: ArrayOf<string>, options?: GlobDirOptions): Promise<string[]>;
         renameFile(src: string | URL, dest: string | URL, throws?: boolean): boolean;
         streamFile<U extends Bufferable>(value: string | URL, cache: boolean): Promise<U>;
         streamFile<U extends ReadBufferOptions>(value: string | URL, options: U): Promise<U extends { encoding: string } ? string : Buffer>;

package/lib/module.d.ts

@@ -100,6 +100,14 @@ export interface CopyDirResult {
     ignored: string[];
 }
 
+export interface GlobDirOptions {
+    exclude?: ArrayOf<string>;
+    recursive?: boolean | number;
+    matchBase?: boolean;
+    dot?: boolean;
+    contains?: boolean;
+}
+
 export interface StreamBase extends StreamAction {
     signal?: AbortSignal;
 }

package/lib/request.d.ts

@@ -60,7 +60,7 @@ export interface OpenOptions extends KeepAliveAction, SilentAction {
     base?: boolean;
     socketPath?: string;
     httpVersion?: HttpProtocolVersion;
-    method?: "GET" | "POST" | "HEAD";
+    method?: HttpMethod | Lowercase<HttpMethod>;
     search?: StringMap;
     /** @deprecated followRedirect */
     follow_redirect?: boolean;
@@ -68,7 +68,8 @@ export interface OpenOptions extends KeepAliveAction, SilentAction {
     encoding?: BufferEncoding;
     maxBufferSize?: number | string;
     format?: BufferFormat | { out?: BufferFormat; parser?: PlainObject };
-    headers?: OutgoingHttpHeaders;
+    headers?: OutgoingHttpHeaders | Headers;
+    signal?: AbortSignal;
     timeout?: number;
     pipeTo?: string | Writable;
     postData?: unknown;
@@ -82,12 +83,15 @@ export interface OpenOptions extends KeepAliveAction, SilentAction {
     outAbort?: AbortController;
 }
 
-export interface PostOptions extends OpenOptions {
+export interface PutOptions extends OpenOptions {
     contentType?: string;
-    formData?: ArrayOf<FormDataPart>;
     dataEncoding?: BufferEncoding;
 }
 
+export interface PostOptions extends PutOptions {
+    formData?: ArrayOf<FormDataPart>;
+}
+
 export interface FormDataPart {
     name?: string;
     data?: Buffer | Readable | string;
@@ -98,7 +102,8 @@ export interface FormDataPart {
 
 export interface Aria2Options extends BinaryAction, SilentAction {
     pathname?: string;
-    headers?: OutgoingHttpHeaders;
+    headers?: OutgoingHttpHeaders | Headers;
+    signal?: AbortSignal;
 }
 
 export interface HostConfig extends OpenOptions {
@@ -133,6 +138,7 @@ export interface ApplyOptions extends ProtocolAction, PlainObject {
     keepAlive?: boolean;
 }
 
+export type HttpMethod = "GET" | "POST" | "PUT" | "HEAD" | "DELETE";
 export type BufferFormat = "json" | "yaml" | "json5" | "xml" | "toml";
 export type ReadExpectType = "always" | "string" | "none";
 export type DataEncodedResult<T extends { encoding?: BufferEncoding }> = T extends { encoding: BufferEncoding } ? string : Null<Bufferable>;

package/lib/type.d.ts

@@ -1,6 +1,4 @@
-/** @deprecated */
 type Undef<T> = T | undefined;
-/** @deprecated */
 type Null<T> = T | null;
 type Void<T> = T | void;
 type Optional<T> = T | null | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e-mc/types",
-  "version": "0.10.2",
+  "version": "0.10.3",
   "description": "Type definitions for E-mc.",
   "main": "index.js",
   "types": "index.d.ts",
@@ -17,7 +17,7 @@
     "squared-functions"
   ],
   "author": "An Pham <anpham6@gmail.com>",
-  "license": "BSD 3-Clause",
+  "license": "BSD-3-Clause",
   "homepage": "https://github.com/anpham6/e-mc#readme",
   "dependencies": {
     "bytes": "^3.1.2"

package/lib/dom.d.ts

@@ -1,9 +0,0 @@
-interface EventListenerOptions {
-    capture?: boolean;
-}
-
-export interface AddEventListenerOptions extends EventListenerOptions {
-    once?: boolean;
-    passive?: boolean;
-    signal?: AbortSignal;
-}