@rulebricks/sdk 1.0.0 → 1.2.0

package/core/fetcher/Fetcher.js

@@ -2,34 +2,22 @@
 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 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());
     });
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetcher = void 0;
-const form_data_1 = __importDefault(require("form-data"));
-const qs_1 = __importDefault(require("qs"));
-const INITIAL_RETRY_DELAY = 1;
-const MAX_RETRY_DELAY = 60;
-const DEFAULT_MAX_RETRIES = 2;
+exports.fetcher = exports.fetcherImpl = void 0;
+const json_1 = require("../json");
+const createRequestUrl_1 = require("./createRequestUrl");
+const getFetchFn_1 = require("./getFetchFn");
+const getRequestBody_1 = require("./getRequestBody");
+const getResponseBody_1 = require("./getResponseBody");
+const makeRequest_1 = require("./makeRequest");
+const requestWithRetries_1 = require("./requestWithRetries");
 function fetcherImpl(args) {
-    var _a, _b;
     return __awaiter(this, void 0, void 0, function* () {
         const headers = {};
         if (args.body !== undefined && args.contentType != null) {
@@ -42,80 +30,21 @@ function fetcherImpl(args) {
                 }
             }
         }
-        const url = Object.keys((_a = args.queryParameters) !== null && _a !== void 0 ? _a : {}).length > 0
-            ? `${args.url}?${qs_1.default.stringify(args.queryParameters, { arrayFormat: "repeat" })}`
-            : args.url;
-        let body = undefined;
-        if (args.body instanceof form_data_1.default) {
-            // @ts-expect-error
-            body = args.body;
-        }
-        else {
-            body = JSON.stringify(args.body);
-        }
-        const fetchFn = typeof fetch == "function" ? fetch : require("node-fetch");
-        const makeRequest = () => __awaiter(this, void 0, void 0, function* () {
-            const controller = new AbortController();
-            let abortId = undefined;
-            if (args.timeoutMs != null) {
-                abortId = setTimeout(() => controller.abort(), args.timeoutMs);
-            }
-            const response = yield fetchFn(url, {
-                method: args.method,
-                headers,
-                body,
-                signal: controller.signal,
-                credentials: args.withCredentials ? "include" : undefined,
-            });
-            if (abortId != null) {
-                clearTimeout(abortId);
-            }
-            return response;
+        const url = (0, createRequestUrl_1.createRequestUrl)(args.url, args.queryParameters);
+        const requestBody = yield (0, getRequestBody_1.getRequestBody)({
+            body: args.body,
+            type: args.requestType === "json" ? "json" : "other",
         });
+        const fetchFn = yield (0, getFetchFn_1.getFetchFn)();
         try {
-            let response = yield makeRequest();
-            for (let i = 0; i < ((_b = args.maxRetries) !== null && _b !== void 0 ? _b : DEFAULT_MAX_RETRIES); ++i) {
-                if (response.status === 408 ||
-                    response.status === 409 ||
-                    response.status === 429 ||
-                    response.status >= 500) {
-                    const delay = Math.min(INITIAL_RETRY_DELAY * Math.pow(i, 2), MAX_RETRY_DELAY);
-                    yield new Promise((resolve) => setTimeout(resolve, delay));
-                    response = yield makeRequest();
-                }
-                else {
-                    break;
-                }
-            }
-            let body;
-            if (response.body != null && args.responseType === "blob") {
-                body = yield response.blob();
-            }
-            else if (response.body != null && args.responseType === "streaming") {
-                body = response.body;
-            }
-            else {
-                const text = yield response.text();
-                if (text.length > 0) {
-                    try {
-                        body = JSON.parse(text);
-                    }
-                    catch (err) {
-                        return {
-                            ok: false,
-                            error: {
-                                reason: "non-json",
-                                statusCode: response.status,
-                                rawBody: text,
-                            },
-                        };
-                    }
-                }
-            }
+            const response = yield (0, requestWithRetries_1.requestWithRetries)(() => __awaiter(this, void 0, void 0, function* () {
+                return (0, makeRequest_1.makeRequest)(fetchFn, url, args.method, headers, requestBody, args.timeoutMs, args.abortSignal, args.withCredentials, args.duplex);
+            }), args.maxRetries);
+            const responseBody = yield (0, getResponseBody_1.getResponseBody)(response, args.responseType);
             if (response.status >= 200 && response.status < 400) {
                 return {
                     ok: true,
-                    body: body,
+                    body: responseBody,
                     headers: response.headers,
                 };
             }
@@ -125,13 +54,22 @@ function fetcherImpl(args) {
                     error: {
                         reason: "status-code",
                         statusCode: response.status,
-                        body,
+                        body: responseBody,
                     },
                 };
             }
         }
         catch (error) {
-            if (error instanceof Error && error.name === "AbortError") {
+            if (args.abortSignal != null && args.abortSignal.aborted) {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "unknown",
+                        errorMessage: "The user aborted a request",
+                    },
+                };
+            }
+            else if (error instanceof Error && error.name === "AbortError") {
                 return {
                     ok: false,
                     error: {
@@ -152,10 +90,11 @@ function fetcherImpl(args) {
                 ok: false,
                 error: {
                     reason: "unknown",
-                    errorMessage: JSON.stringify(error),
+                    errorMessage: (0, json_1.toJson)(error),
                 },
             };
         }
     });
 }
+exports.fetcherImpl = fetcherImpl;
 exports.fetcher = fetcherImpl;

package/core/fetcher/Supplier.d.ts

@@ -1,4 +1,4 @@
-export var __esModule: boolean;
-export namespace Supplier {
-    function get(supplier: any): any;
-}
+export declare type Supplier<T> = T | Promise<T> | (() => T | Promise<T>);
+export declare const Supplier: {
+    get: <T>(supplier: Supplier<T>) => Promise<T>;
+};

package/core/fetcher/Supplier.js

@@ -2,18 +2,8 @@
 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 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());
     });

package/core/fetcher/createRequestUrl.d.ts

@@ -0,0 +1 @@
+export declare function createRequestUrl(baseUrl: string, queryParameters?: Record<string, string | string[] | object | object[] | null>): string;

package/core/fetcher/createRequestUrl.js

@@ -0,0 +1,13 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRequestUrl = void 0;
+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;
+}
+exports.createRequestUrl = createRequestUrl;

package/core/fetcher/getFetchFn.d.ts

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

package/core/fetcher/getFetchFn.js

@@ -0,0 +1,59 @@
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __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 = void 0;
+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;
+    });
+}
+exports.getFetchFn = getFetchFn;

package/core/fetcher/getHeader.d.ts

@@ -1,2 +1 @@
-export var __esModule: boolean;
-export function getHeader(headers: any, header: any): any;
+export declare function getHeader(headers: Record<string, any>, header: string): string | undefined;

package/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/core/fetcher/getRequestBody.js

@@ -0,0 +1,24 @@
+"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 = void 0;
+const json_1 = require("../json");
+function getRequestBody({ body, type }) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (type.includes("json")) {
+            return (0, json_1.toJson)(body);
+        }
+        else {
+            return body;
+        }
+    });
+}
+exports.getRequestBody = getRequestBody;

package/core/fetcher/getResponseBody.d.ts

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

package/core/fetcher/getResponseBody.js

@@ -0,0 +1,55 @@
+"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 = void 0;
+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;
+            }
+        }
+    });
+}
+exports.getResponseBody = getResponseBody;

package/core/fetcher/index.d.ts

@@ -1,9 +1,5 @@
-export var __esModule: boolean;
-export var fetcher: Fetcher_1.FetchFunction;
-export var getHeader: typeof getHeader_1.getHeader;
-export var Supplier: {
-    get: <T>(supplier: Supplier_1.Supplier<T>) => Promise<T>;
-};
-import Fetcher_1 = require("./Fetcher");
-import getHeader_1 = require("./getHeader");
-import Supplier_1 = require("./Supplier");
+export type { APIResponse } from "./APIResponse";
+export { fetcher } from "./Fetcher";
+export type { Fetcher, FetchFunction } from "./Fetcher";
+export { getHeader } from "./getHeader";
+export { Supplier } from "./Supplier";

package/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 | undefined, abortSignal?: AbortSignal | undefined, withCredentials?: boolean | undefined, duplex?: "half" | undefined) => Promise<Response>;

package/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/core/fetcher/requestWithRetries.d.ts

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

package/core/fetcher/requestWithRetries.js

@@ -0,0 +1,41 @@
+"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 = void 0;
+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, maxRetries = DEFAULT_MAX_RETRIES) {
+    return __awaiter(this, void 0, void 0, function* () {
+        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;
+    });
+}
+exports.requestWithRetries = requestWithRetries;

package/core/fetcher/signals.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="node" />
+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/core/fetcher/signals.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.anySignal = exports.getTimeoutSignal = void 0;
+const TIMEOUT = "timeout";
+function getTimeoutSignal(timeoutMs) {
+    const controller = new AbortController();
+    const abortId = setTimeout(() => controller.abort(TIMEOUT), timeoutMs);
+    return { signal: controller.signal, abortId };
+}
+exports.getTimeoutSignal = getTimeoutSignal;
+/**
+ * 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;
+}
+exports.anySignal = anySignal;

package/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>;
+}