@trycourier/courier 6.3.1 → 6.4.0

package/dist/core/fetcher/createRequestUrl.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRequestUrl = createRequestUrl;
+const qs_1 = __importDefault(require("qs"));
+function createRequestUrl(baseUrl, queryParameters) {
+    return Object.keys(queryParameters !== null && queryParameters !== void 0 ? queryParameters : {}).length > 0
+        ? `${baseUrl}?${qs_1.default.stringify(queryParameters, { arrayFormat: "repeat" })}`
+        : baseUrl;
+}

package/dist/core/fetcher/getFetchFn.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Returns a fetch function based on the runtime
+ */
+export declare function getFetchFn(): Promise<any>;

package/dist/core/fetcher/getFetchFn.js

@@ -0,0 +1,68 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFetchFn = getFetchFn;
+const runtime_1 = require("../runtime");
+/**
+ * Returns a fetch function based on the runtime
+ */
+function getFetchFn() {
+    return __awaiter(this, void 0, void 0, function* () {
+        // In Node.js 18+ environments, use native fetch
+        if (runtime_1.RUNTIME.type === "node" && runtime_1.RUNTIME.parsedVersion != null && runtime_1.RUNTIME.parsedVersion >= 18) {
+            return fetch;
+        }
+        // In Node.js 18 or lower environments, the SDK always uses`node-fetch`.
+        if (runtime_1.RUNTIME.type === "node") {
+            return (yield Promise.resolve().then(() => __importStar(require("node-fetch")))).default;
+        }
+        // Otherwise the SDK uses global fetch if available,
+        // and falls back to node-fetch.
+        if (typeof fetch == "function") {
+            return fetch;
+        }
+        // Defaults to node `node-fetch` if global fetch isn't available
+        return (yield Promise.resolve().then(() => __importStar(require("node-fetch")))).default;
+    });
+}

package/dist/core/fetcher/getHeader.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getHeader = void 0;
+exports.getHeader = getHeader;
 function getHeader(headers, header) {
     for (const [headerKey, headerValue] of Object.entries(headers)) {
         if (headerKey.toLowerCase() === header.toLowerCase()) {
@@ -9,4 +9,3 @@ function getHeader(headers, header) {
     }
     return undefined;
 }
-exports.getHeader = getHeader;

package/dist/core/fetcher/getRequestBody.d.ts

@@ -0,0 +1,7 @@
+export declare namespace GetRequestBody {
+    interface Args {
+        body: unknown;
+        type: "json" | "file" | "bytes" | "other";
+    }
+}
+export declare function getRequestBody({ body, type }: GetRequestBody.Args): Promise<BodyInit | undefined>;

package/dist/core/fetcher/getRequestBody.js

@@ -0,0 +1,23 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRequestBody = getRequestBody;
+const json_1 = require("../json");
+function getRequestBody(_a) {
+    return __awaiter(this, arguments, void 0, function* ({ body, type }) {
+        if (type.includes("json")) {
+            return (0, json_1.toJson)(body);
+        }
+        else {
+            return body;
+        }
+    });
+}

package/dist/core/fetcher/getResponseBody.d.ts

@@ -0,0 +1 @@
+export declare function getResponseBody(response: Response, responseType?: string): Promise<unknown>;

package/dist/core/fetcher/getResponseBody.js

@@ -0,0 +1,54 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getResponseBody = getResponseBody;
+const chooseStreamWrapper_1 = require("./stream-wrappers/chooseStreamWrapper");
+function getResponseBody(response, responseType) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (response.body != null && responseType === "blob") {
+            return yield response.blob();
+        }
+        else if (response.body != null && responseType === "arrayBuffer") {
+            return yield response.arrayBuffer();
+        }
+        else if (response.body != null && responseType === "sse") {
+            return response.body;
+        }
+        else if (response.body != null && responseType === "streaming") {
+            return (0, chooseStreamWrapper_1.chooseStreamWrapper)(response.body);
+        }
+        else if (response.body != null && responseType === "text") {
+            return yield response.text();
+        }
+        else {
+            const text = yield response.text();
+            if (text.length > 0) {
+                try {
+                    let responseBody = JSON.parse(text);
+                    return responseBody;
+                }
+                catch (err) {
+                    return {
+                        ok: false,
+                        error: {
+                            reason: "non-json",
+                            statusCode: response.status,
+                            rawBody: text,
+                        },
+                    };
+                }
+            }
+            else {
+                return undefined;
+            }
+        }
+    });
+}

package/dist/core/fetcher/makeRequest.d.ts

@@ -0,0 +1 @@
+export declare const makeRequest: (fetchFn: (url: string, init: RequestInit) => Promise<Response>, url: string, method: string, headers: Record<string, string>, requestBody: BodyInit | undefined, timeoutMs?: number, abortSignal?: AbortSignal, withCredentials?: boolean, duplex?: "half") => Promise<Response>;

package/dist/core/fetcher/makeRequest.js

@@ -0,0 +1,42 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeRequest = void 0;
+const signals_1 = require("./signals");
+const makeRequest = (fetchFn, url, method, headers, requestBody, timeoutMs, abortSignal, withCredentials, duplex) => __awaiter(void 0, void 0, void 0, function* () {
+    const signals = [];
+    // Add timeout signal
+    let timeoutAbortId = undefined;
+    if (timeoutMs != null) {
+        const { signal, abortId } = (0, signals_1.getTimeoutSignal)(timeoutMs);
+        timeoutAbortId = abortId;
+        signals.push(signal);
+    }
+    // Add arbitrary signal
+    if (abortSignal != null) {
+        signals.push(abortSignal);
+    }
+    let newSignals = (0, signals_1.anySignal)(signals);
+    const response = yield fetchFn(url, {
+        method: method,
+        headers,
+        body: requestBody,
+        signal: newSignals,
+        credentials: withCredentials ? "include" : undefined,
+        // @ts-ignore
+        duplex,
+    });
+    if (timeoutAbortId != null) {
+        clearTimeout(timeoutAbortId);
+    }
+    return response;
+});
+exports.makeRequest = makeRequest;

package/dist/core/fetcher/requestWithRetries.d.ts

@@ -0,0 +1 @@
+export declare function requestWithRetries(requestFn: () => Promise<Response>, maxRetries?: number): Promise<Response>;

package/dist/core/fetcher/requestWithRetries.js

@@ -0,0 +1,40 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requestWithRetries = requestWithRetries;
+const INITIAL_RETRY_DELAY = 1000; // in milliseconds
+const MAX_RETRY_DELAY = 60000; // in milliseconds
+const DEFAULT_MAX_RETRIES = 2;
+const JITTER_FACTOR = 0.2; // 20% random jitter
+function addJitter(delay) {
+    // Generate a random value between -JITTER_FACTOR and +JITTER_FACTOR
+    const jitterMultiplier = 1 + (Math.random() * 2 - 1) * JITTER_FACTOR;
+    return delay * jitterMultiplier;
+}
+function requestWithRetries(requestFn_1) {
+    return __awaiter(this, arguments, void 0, function* (requestFn, maxRetries = DEFAULT_MAX_RETRIES) {
+        let response = yield requestFn();
+        for (let i = 0; i < maxRetries; ++i) {
+            if ([408, 429].includes(response.status) || response.status >= 500) {
+                // Calculate base delay using exponential backoff (in milliseconds)
+                const baseDelay = Math.min(INITIAL_RETRY_DELAY * Math.pow(2, i), MAX_RETRY_DELAY);
+                // Add jitter to the delay
+                const delayWithJitter = addJitter(baseDelay);
+                yield new Promise((resolve) => setTimeout(resolve, delayWithJitter));
+                response = yield requestFn();
+            }
+            else {
+                break;
+            }
+        }
+        return response;
+    });
+}

package/dist/core/fetcher/signals.d.ts

@@ -0,0 +1,11 @@
+export declare function getTimeoutSignal(timeoutMs: number): {
+    signal: AbortSignal;
+    abortId: NodeJS.Timeout;
+};
+/**
+ * Returns an abort signal that is getting aborted when
+ * at least one of the specified abort signals is aborted.
+ *
+ * Requires at least node.js 18.
+ */
+export declare function anySignal(...args: AbortSignal[] | [AbortSignal[]]): AbortSignal;

package/dist/core/fetcher/signals.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTimeoutSignal = getTimeoutSignal;
+exports.anySignal = anySignal;
+const TIMEOUT = "timeout";
+function getTimeoutSignal(timeoutMs) {
+    const controller = new AbortController();
+    const abortId = setTimeout(() => controller.abort(TIMEOUT), timeoutMs);
+    return { signal: controller.signal, abortId };
+}
+/**
+ * Returns an abort signal that is getting aborted when
+ * at least one of the specified abort signals is aborted.
+ *
+ * Requires at least node.js 18.
+ */
+function anySignal(...args) {
+    // Allowing signals to be passed either as array
+    // of signals or as multiple arguments.
+    const signals = (args.length === 1 && Array.isArray(args[0]) ? args[0] : args);
+    const controller = new AbortController();
+    for (const signal of signals) {
+        if (signal.aborted) {
+            // Exiting early if one of the signals
+            // is already aborted.
+            controller.abort(signal === null || signal === void 0 ? void 0 : signal.reason);
+            break;
+        }
+        // Listening for signals and removing the listeners
+        // when at least one symbol is aborted.
+        signal.addEventListener("abort", () => controller.abort(signal === null || signal === void 0 ? void 0 : signal.reason), {
+            signal: controller.signal,
+        });
+    }
+    return controller.signal;
+}

package/dist/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.d.ts

@@ -0,0 +1,30 @@
+import type { Writable } from "readable-stream";
+import { EventCallback, StreamWrapper } from "./chooseStreamWrapper";
+export declare class Node18UniversalStreamWrapper<ReadFormat extends Uint8Array | Uint16Array | Uint32Array> implements StreamWrapper<Node18UniversalStreamWrapper<ReadFormat> | Writable | WritableStream<ReadFormat>, ReadFormat> {
+    private readableStream;
+    private reader;
+    private events;
+    private paused;
+    private resumeCallback;
+    private encoding;
+    constructor(readableStream: ReadableStream<ReadFormat>);
+    on(event: string, callback: EventCallback): void;
+    off(event: string, callback: EventCallback): void;
+    pipe(dest: Node18UniversalStreamWrapper<ReadFormat> | Writable | WritableStream<ReadFormat>): Node18UniversalStreamWrapper<ReadFormat> | Writable | WritableStream<ReadFormat>;
+    pipeTo(dest: Node18UniversalStreamWrapper<ReadFormat> | Writable | WritableStream<ReadFormat>): Node18UniversalStreamWrapper<ReadFormat> | Writable | WritableStream<ReadFormat>;
+    unpipe(dest: Node18UniversalStreamWrapper<ReadFormat> | Writable | WritableStream<ReadFormat>): void;
+    destroy(error?: Error): void;
+    pause(): void;
+    resume(): void;
+    get isPaused(): boolean;
+    read(): Promise<ReadFormat | undefined>;
+    setEncoding(encoding: string): void;
+    text(): Promise<string>;
+    json<T>(): Promise<T>;
+    private _write;
+    private _end;
+    private _error;
+    private _emit;
+    private _startReading;
+    [Symbol.asyncIterator](): AsyncIterableIterator<ReadFormat>;
+}

package/dist/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.js

@@ -0,0 +1,247 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Node18UniversalStreamWrapper = void 0;
+class Node18UniversalStreamWrapper {
+    constructor(readableStream) {
+        this.readableStream = readableStream;
+        this.reader = this.readableStream.getReader();
+        this.events = {
+            data: [],
+            end: [],
+            error: [],
+            readable: [],
+            close: [],
+            pause: [],
+            resume: [],
+        };
+        this.paused = false;
+        this.resumeCallback = null;
+        this.encoding = null;
+    }
+    on(event, callback) {
+        var _a;
+        (_a = this.events[event]) === null || _a === void 0 ? void 0 : _a.push(callback);
+    }
+    off(event, callback) {
+        var _a;
+        this.events[event] = (_a = this.events[event]) === null || _a === void 0 ? void 0 : _a.filter((cb) => cb !== callback);
+    }
+    pipe(dest) {
+        this.on("data", (chunk) => __awaiter(this, void 0, void 0, function* () {
+            if (dest instanceof Node18UniversalStreamWrapper) {
+                dest._write(chunk);
+            }
+            else if (dest instanceof WritableStream) {
+                const writer = dest.getWriter();
+                writer.write(chunk).then(() => writer.releaseLock());
+            }
+            else {
+                dest.write(chunk);
+            }
+        }));
+        this.on("end", () => __awaiter(this, void 0, void 0, function* () {
+            if (dest instanceof Node18UniversalStreamWrapper) {
+                dest._end();
+            }
+            else if (dest instanceof WritableStream) {
+                const writer = dest.getWriter();
+                writer.close();
+            }
+            else {
+                dest.end();
+            }
+        }));
+        this.on("error", (error) => __awaiter(this, void 0, void 0, function* () {
+            if (dest instanceof Node18UniversalStreamWrapper) {
+                dest._error(error);
+            }
+            else if (dest instanceof WritableStream) {
+                const writer = dest.getWriter();
+                writer.abort(error);
+            }
+            else {
+                dest.destroy(error);
+            }
+        }));
+        this._startReading();
+        return dest;
+    }
+    pipeTo(dest) {
+        return this.pipe(dest);
+    }
+    unpipe(dest) {
+        this.off("data", (chunk) => __awaiter(this, void 0, void 0, function* () {
+            if (dest instanceof Node18UniversalStreamWrapper) {
+                dest._write(chunk);
+            }
+            else if (dest instanceof WritableStream) {
+                const writer = dest.getWriter();
+                writer.write(chunk).then(() => writer.releaseLock());
+            }
+            else {
+                dest.write(chunk);
+            }
+        }));
+        this.off("end", () => __awaiter(this, void 0, void 0, function* () {
+            if (dest instanceof Node18UniversalStreamWrapper) {
+                dest._end();
+            }
+            else if (dest instanceof WritableStream) {
+                const writer = dest.getWriter();
+                writer.close();
+            }
+            else {
+                dest.end();
+            }
+        }));
+        this.off("error", (error) => __awaiter(this, void 0, void 0, function* () {
+            if (dest instanceof Node18UniversalStreamWrapper) {
+                dest._error(error);
+            }
+            else if (dest instanceof WritableStream) {
+                const writer = dest.getWriter();
+                writer.abort(error);
+            }
+            else {
+                dest.destroy(error);
+            }
+        }));
+    }
+    destroy(error) {
+        this.reader
+            .cancel(error)
+            .then(() => {
+            this._emit("close");
+        })
+            .catch((err) => {
+            this._emit("error", err);
+        });
+    }
+    pause() {
+        this.paused = true;
+        this._emit("pause");
+    }
+    resume() {
+        if (this.paused) {
+            this.paused = false;
+            this._emit("resume");
+            if (this.resumeCallback) {
+                this.resumeCallback();
+                this.resumeCallback = null;
+            }
+        }
+    }
+    get isPaused() {
+        return this.paused;
+    }
+    read() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.paused) {
+                yield new Promise((resolve) => {
+                    this.resumeCallback = resolve;
+                });
+            }
+            const { done, value } = yield this.reader.read();
+            if (done) {
+                return undefined;
+            }
+            return value;
+        });
+    }
+    setEncoding(encoding) {
+        this.encoding = encoding;
+    }
+    text() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const chunks = [];
+            while (true) {
+                const { done, value } = yield this.reader.read();
+                if (done) {
+                    break;
+                }
+                if (value) {
+                    chunks.push(value);
+                }
+            }
+            const decoder = new TextDecoder(this.encoding || "utf-8");
+            return decoder.decode(yield new Blob(chunks).arrayBuffer());
+        });
+    }
+    json() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const text = yield this.text();
+            return JSON.parse(text);
+        });
+    }
+    _write(chunk) {
+        this._emit("data", chunk);
+    }
+    _end() {
+        this._emit("end");
+    }
+    _error(error) {
+        this._emit("error", error);
+    }
+    _emit(event, data) {
+        if (this.events[event]) {
+            for (const callback of this.events[event] || []) {
+                callback(data);
+            }
+        }
+    }
+    _startReading() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                this._emit("readable");
+                while (true) {
+                    if (this.paused) {
+                        yield new Promise((resolve) => {
+                            this.resumeCallback = resolve;
+                        });
+                    }
+                    const { done, value } = yield this.reader.read();
+                    if (done) {
+                        this._emit("end");
+                        this._emit("close");
+                        break;
+                    }
+                    if (value) {
+                        this._emit("data", value);
+                    }
+                }
+            }
+            catch (error) {
+                this._emit("error", error);
+            }
+        });
+    }
+    [Symbol.asyncIterator]() {
+        return {
+            next: () => __awaiter(this, void 0, void 0, function* () {
+                if (this.paused) {
+                    yield new Promise((resolve) => {
+                        this.resumeCallback = resolve;
+                    });
+                }
+                const { done, value } = yield this.reader.read();
+                if (done) {
+                    return { done: true, value: undefined };
+                }
+                return { done: false, value };
+            }),
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+        };
+    }
+}
+exports.Node18UniversalStreamWrapper = Node18UniversalStreamWrapper;

package/dist/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts

@@ -0,0 +1,21 @@
+import type { Readable, Writable } from "readable-stream";
+import { EventCallback, StreamWrapper } from "./chooseStreamWrapper";
+export declare class NodePre18StreamWrapper implements StreamWrapper<Writable, Buffer> {
+    private readableStream;
+    private encoding;
+    constructor(readableStream: Readable);
+    on(event: string, callback: EventCallback): void;
+    off(event: string, callback: EventCallback): void;
+    pipe(dest: Writable): Writable;
+    pipeTo(dest: Writable): Writable;
+    unpipe(dest?: Writable): void;
+    destroy(error?: Error): void;
+    pause(): void;
+    resume(): void;
+    get isPaused(): boolean;
+    read(): Promise<Buffer | undefined>;
+    setEncoding(encoding?: string): void;
+    text(): Promise<string>;
+    json<T>(): Promise<T>;
+    [Symbol.asyncIterator](): AsyncIterableIterator<Buffer>;
+}