Request constructor for E-mc.
npm install @e-mc/request* NodeJS 18.20.5 LTS
* ES2022
``typescript
import type { IModule, ModuleConstructor } from "./index";
import type { HttpAgentSettings, HttpProtocolVersion, HttpRequestClient, InternetProtocolVersion } from "./http";
import type { ApplyOptions, Aria2Options, FormDataPart, HeadersOnCallback, HostConfig, IHttpAdapter, OpenOptions, PostOptions, ProxySettings, PutOptions, RcloneOptions, ReadExpectType, RequestInit, StatusOnCallback } from "./request";
import type { DnsLookupSettings, RequestModule, RequestSettings } from "./settings";
import type { ClientRequest, OutgoingHttpHeaders } from "node:http";
import type { LookupFunction } from "node:net";
import type { Writable } from "node:stream";
interface IRequest extends IModule {
module: RequestModule;
startTime: number;
acceptEncoding: boolean;
keepAlive: boolean | null;
readTimeout: number;
readExpect: ReadExpectType;
proxy: ProxySettings | null;
init(config?: RequestInit): this;
apply(options: ApplyOptions): this;
addDns(hostname: string, address: string, timeout: number): void;
addDns(hostname: string, address: string, family?: string, timeout?: number): void;
lookupDns(hostname: string): LookupFunction;
proxyOf(uri: string, localhost?: boolean): ProxySettings | undefined;
statusOn(name: number | number[], callback: StatusOnCallback): void;
statusOn(name: number | number[], globUrl: string, callback: StatusOnCallback): void;
headersOn(name: string | string[], callback: HeadersOnCallback): void;
headersOn(name: string | string[], globUrl: string, callback: HeadersOnCallback): void;
headersOf(uri: string): OutgoingHttpHeaders | undefined;
aria2c(uri: string | URL, pathname: string | URL): Promise
aria2c(uri: string | URL, options?: Aria2Options): Promise
rclone(uri: string | URL, pathname: string | URL): Promise
rclone(uri: string | URL, options?: RcloneOptions): Promise
json(uri: string | URL, options?: OpenOptions): Promise
interface RequestConstructor extends ModuleConstructor {
readCACert(value: string, cache?: boolean): string;
readTLSKey(value: string, cache?: boolean): string;
readTLSCert(value: string, cache?: boolean): string;
isCert(value: string): boolean;
defineHttpAgent(options: HttpAgentSettings): void;
defineDnsLookup(options: DnsLookupSettings, clear?: boolean): void;
defineHttpAdapter(module: unknown): void;
isRclone(value: string | URL): boolean;
getAria2Path(): string;
getRclonePath(): string;
readonly prototype: IRequest;
new(module?: RequestModule): IRequest;
}
`
`typescript
import type { PermittedDirectories } from "./core";
import type { SecureConfig } from "./http";
import type { PurgeComponent } from "./settings";
import type { LookupAddress } from "dns";
import type { OutgoingHttpHeaders } from "http";
interface RequestModule {
handler: "@e-mc/request";
timeout?: number | string;
read_timeout?: number | string;
agent?: {
keep_alive?: boolean;
timeout?: number | string;
};
connect?: {
timeout?: number | string;
retry_wait?: number | string;
retry_after?: number | string;
retry_limit?: number;
redirect_limit?: number;
};
dns?: {
family?: number;
expires?: number | string;
resolve?: Record
};
use?: {
http_version?: 1 | 2;
accept_encoding?: boolean;
};
proxy?: {
address?: string;
port?: number;
origin?: string;
username?: string;
password?: string;
include?: string[];
exclude?: string[];
keep_alive?: boolean;
};
headers: Record
certs?: Record
localhost?: string[];
protocol?: {
"http/1.1"?: string[];
h2c?: string[];
h2?: string[];
};
write_stream?: Record
post_limit?: number | string;
settings?: {
broadcast_id?: string | string[];
time_format?: "readable" | "relative" | "none";
purge?: PurgeComponent;
}
}
interface DownloadModule {
expires?: number | string;
aria2?: {
bin?: string | false;
exec?: {
uid?: number;
gid?: number;
};
update_status?: number | { interval?: number; broadcast_only?: boolean };
max_concurrent_downloads?: number;
max_connection_per_server?: number;
check_integrity?: boolean;
bt_stop_timeout?: number;
bt_tracker_connect_timeout?: number;
bt_tracker_timeout?: number;
min_split_size?: string;
disk_cache?: number | string;
lowest_speed_limit?: number | string;
always_resume?: boolean;
file_allocation?: "none" | "prealloc" | "trunc" | "falloc";
conf_path?: string;
};
rclone?: {
bin?: string | false;
exec?: {
uid?: number;
gid?: number;
};
/ Copy /
check_first?: boolean;
checksum?: boolean;
cutoff_mode?: "HARD" | "SOFT" | "CAUTIOUS";
ignore_case_sync?: boolean;
ignore_checksum?: boolean;
ignore_existing?: boolean;
ignore_size?: boolean;
ignore_times?: boolean;
immutable?: boolean;
inplace?: boolean;
max_backlog?: number;
max_duration?: string;
max_transfer?: string;
metadata?: boolean;
modify_window?: string;
multi_thread_chunk_size?: string;
multi_thread_cutoff?: string;
multi_thread_streams?: number;
multi_thread_write_buffer_size?: string;
no_check_dest?: boolean;
no_traverse?: boolean;
no_update_dir_modtime?: boolean;
refresh_times?: boolean;
size_only?: boolean;
update?: boolean;
/ Listing /
fast_list?: boolean;
/ Networking /
bind?: string;
contimeout?: string;
disable_http2?: boolean;
timeout?: string;
/ Config /
config?: string;
};
}
`
`javascript
const Request = require("@e-mc/request");
const instance = new Request({
read_timeout: 30,
connect: {
timeout: 20, // Seconds
retry_wait: 1,
retry_after: 30,
retry_limit: 3, // Max attempts
redirect_limit: 10
},
use: {
http_version: 2,
accept_encoding: true
},
dns: {
family: 4 // ipVersion
},
agent: { keep_alive: true }
});
request.init({ ipVersion: 6 });
const options = {
format: "yaml",
httpVersion: 1,
silent: true,
headers: { "x-goog-user-project": "project-1" }
};
instance.get("http://hostname/path/config.yml", options).then(data => {
console.log(data.property);
});
``
- https://www.unpkg.com/@e-mc/types@0.13.7/lib/http.d.ts
- https://www.unpkg.com/@e-mc/types@0.13.7/lib/request.d.ts
- https://www.unpkg.com/@e-mc/types@0.13.7/lib/settings.d.ts
* https://www.npmjs.com/package/@types/node
BSD 3-Clause