@juzi/file-box 1.7.0

package/dist/cjs/tests/network-timeout.spec.js

@@ -0,0 +1,121 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const http_1 = require("http");
+const promises_1 = require("timers/promises");
+const tstest_1 = require("tstest");
+const mod_js_1 = require("../src/mod.js");
+const config_js_1 = require("../src/config.js");
+(0, tstest_1.test)('slow network stall HTTP_TIMEOUT', async (t) => {
+    const sandbox = tstest_1.sinon.createSandbox();
+    sandbox.useFakeTimers({
+        now: Date.now(),
+        shouldAdvanceTime: true,
+        shouldClearNativeTimers: true,
+        toFake: ['setTimeout', 'clearTimeout', 'setInterval', 'clearInterval', 'nextTick'],
+    });
+    t.jobs = 3;
+    const port = Math.floor(Math.random() * (65535 - 49152 + 1)) + 49152;
+    const URL = {
+        NOT_TIMEOUT: '/not_timeout',
+        READY: '/ready',
+        TIMEOUT: '/timeout',
+    };
+    /* eslint @typescript-eslint/no-misused-promises:off */
+    const server = (0, http_1.createServer)(async (req, res) => {
+        res.write(Buffer.from('This is the first chunk of data.'));
+        if (req.url === URL.NOT_TIMEOUT) {
+            await (0, promises_1.setTimeout)(config_js_1.HTTP_TIMEOUT * 0.5);
+            res.write(Buffer.from('This is the second chunk of data.'));
+            await (0, promises_1.setTimeout)(config_js_1.HTTP_TIMEOUT * 0.9);
+        }
+        else {
+            await (0, promises_1.setTimeout)(config_js_1.HTTP_TIMEOUT + 100);
+        }
+        // console.debug(`${new Date().toLocaleTimeString()} call res.end "${req.url}"`)
+        res.end(Buffer.from('All data end.'));
+    });
+    const host = await new Promise((resolve) => {
+        server.listen(port, '127.0.0.1', () => {
+            const addr = server.address();
+            // console.debug(`Server is listening on port ${JSON.stringify(addr)}`)
+            resolve(`http://127.0.0.1:${addr.port}`);
+        });
+    });
+    t.teardown(() => {
+        // console.debug('teardown')
+        server.close();
+        sandbox.restore();
+    });
+    /** eslint @typescript-eslint/no-floating-promises:off */
+    t.test('should not timeout', async (t) => {
+        const url = `${host}${URL.NOT_TIMEOUT}`;
+        const dataSpy = sandbox.spy();
+        const errorSpy = sandbox.spy();
+        // console.debug(`${new Date().toLocaleTimeString()} Start request "${url}" ...`)
+        const start = Date.now();
+        const stream = await mod_js_1.FileBox.fromUrl(url).toStream();
+        stream.once('error', errorSpy).on('data', dataSpy);
+        await sandbox.clock.tickAsync(1);
+        t.ok(dataSpy.calledOnce, `should get chunk 1 (${Date.now() - start} passed)`);
+        t.ok(errorSpy.notCalled, `should not get error (${Date.now() - start} passed)`);
+        // FIXME: tickAsync does not work on socket timeout
+        await new Promise((resolve) => {
+            stream.once('error', resolve).on('close', resolve);
+            // resolve(setTimeout(HTTP_TIMEOUT))
+        });
+        await sandbox.clock.tickAsync(1);
+        // await sandbox.clock.tickAsync(HTTP_TIMEOUT)
+        // t.comment('recv data count:', dataSpy.callCount)
+        // t.comment('recv error count:', errorSpy.callCount)
+        t.ok(dataSpy.calledThrice, `should get chunk 3 after TIMEOUT ${config_js_1.HTTP_TIMEOUT} (${Date.now() - start} passed)`);
+        t.ok(errorSpy.notCalled, `should not get error after TIMEOUT ${config_js_1.HTTP_TIMEOUT} (${Date.now() - start} passed)`);
+        t.end();
+    }).catch(t.threw);
+    /** eslint @typescript-eslint/no-floating-promises:off */
+    t.test('should timeout', async (t) => {
+        const url = `${host}${URL.TIMEOUT}`;
+        const dataSpy = sandbox.spy();
+        const errorSpy = sandbox.spy();
+        // console.debug(`${new Date().toLocaleTimeString()} Start request "${url}" ...`)
+        const start = Date.now();
+        const stream = await mod_js_1.FileBox.fromUrl(url).toStream();
+        stream.once('error', errorSpy).once('data', dataSpy);
+        // .on('error', (e) => {
+        //   console.error(`on error for req "${url}":`, e.stack)
+        // })
+        // .on('data', (d: Buffer) => {
+        //   console.error(`on data for req "${url}":`, d.toString())
+        // })
+        await sandbox.clock.tickAsync(1);
+        // t.comment('recv data count:', dataSpy.callCount)
+        // t.comment('recv error count:', errorSpy.callCount)
+        t.ok(dataSpy.calledOnce, `should get chunk 1 (${Date.now() - start} passed)`);
+        t.ok(errorSpy.notCalled, `should not get error (${Date.now() - start} passed)`);
+        // FIXME: tickAsync does not work on socket timeout
+        await new Promise((resolve) => {
+            stream.once('error', resolve).on('close', resolve);
+            // resolve(setTimeout(HTTP_TIMEOUT))
+        });
+        await sandbox.clock.tickAsync(1);
+        // await sandbox.clock.tickAsync(HTTP_TIMEOUT)
+        // t.comment('recv data count:', dataSpy.callCount)
+        // t.comment('recv error count:', errorSpy.callCount)
+        t.ok(errorSpy.calledOnce, `should get error after TIMEOUT ${config_js_1.HTTP_TIMEOUT} (${Date.now() - start} passed)`);
+        t.end();
+    }).catch(t.threw);
+    /** eslint @typescript-eslint/no-floating-promises:off */
+    t.test('ready should timeout', async (t) => {
+        const url = `${host}${URL.READY}`;
+        const errorSpy = sandbox.spy();
+        // console.debug(`${new Date().toLocaleTimeString()} Start request "${url}" ...`)
+        const start = Date.now();
+        const fileBox = mod_js_1.FileBox.fromUrl(url);
+        await fileBox.ready().catch(errorSpy);
+        await sandbox.clock.tickAsync(1);
+        // t.comment('recv error count:', errorSpy.callCount)
+        t.ok(errorSpy.calledOnce, `should get error after TIMEOUT ${config_js_1.HTTP_TIMEOUT} (${Date.now() - start} passed)`);
+        t.end();
+    }).catch(t.threw);
+});
+//# sourceMappingURL=network-timeout.spec.js.map

package/dist/cjs/tests/network-timeout.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"network-timeout.spec.js","sourceRoot":"","sources":["../../../tests/network-timeout.spec.ts"],"names":[],"mappings":";;;AAEA,+BAAmC;AAEnC,8CAA4C;AAC5C,mCAAoC;AAEpC,0CAAuC;AAEvC,gDAA+C;AAE/C,IAAA,aAAI,EAAC,iCAAiC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;IAClD,MAAM,OAAO,GAAG,cAAK,CAAC,aAAa,EAAE,CAAA;IACrC,OAAO,CAAC,aAAa,CAAC;QACpB,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE;QACf,iBAAiB,EAAE,IAAI;QACvB,uBAAuB,EAAE,IAAI;QAC7B,MAAM,EAAE,CAAE,YAAY,EAAE,cAAc,EAAE,aAAa,EAAE,eAAe,EAAE,UAAU,CAAE;KACrF,CAAC,CAAA;IACF,CAAC,CAAC,IAAI,GAAG,CAAC,CAAA;IACV,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,CAAA;IACpE,MAAM,GAAG,GAAG;QACV,WAAW,EAAE,cAAc;QAC3B,KAAK,EAAE,QAAQ;QACf,OAAO,EAAE,UAAU;KACpB,CAAA;IAED,uDAAuD;IACvD,MAAM,MAAM,GAAG,IAAA,mBAAY,EAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;QAC7C,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC,CAAA;QAE1D,IAAI,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,WAAW,EAAE;YAC/B,MAAM,IAAA,qBAAU,EAAC,wBAAY,GAAG,GAAG,CAAC,CAAA;YACpC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC,CAAA;YAC3D,MAAM,IAAA,qBAAU,EAAC,wBAAY,GAAG,GAAG,CAAC,CAAA;SACrC;aAAM;YACL,MAAM,IAAA,qBAAU,EAAC,wBAAY,GAAG,GAAG,CAAC,CAAA;SACrC;QAED,gFAAgF;QAChF,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAA;IACvC,CAAC,CAAC,CAAA;IAEF,MAAM,IAAI,GAAG,MAAM,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,EAAE;QACjD,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,WAAW,EAAE,GAAG,EAAE;YACpC,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAiB,CAAA;YAC5C,uEAAuE;YACvE,OAAO,CAAC,oBAAoB,IAAI,CAAC,IAAI,EAAE,CAAC,CAAA;QAC1C,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE;QACd,4BAA4B;QAC5B,MAAM,CAAC,KAAK,EAAE,CAAA;QACd,OAAO,CAAC,OAAO,EAAE,CAAA;IACnB,CAAC,CAAC,CAAA;IAEF,yDAAyD;IACzD,CAAC,CAAC,IAAI,CAAC,oBAAoB,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;QACvC,MAAM,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,CAAC,WAAW,EAAE,CAAA;QACvC,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,EAAE,CAAA;QAC7B,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,EAAE,CAAA;QAE9B,iFAAiF;QACjF,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACxB,MAAM,MAAM,GAAG,MAAM,gBAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAA;QAEpD,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAElD,MAAM,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QAChC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,UAAU,EAAE,uBAAuB,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,UAAU,CAAC,CAAA;QAC7E,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,SAAS,EAAE,yBAAyB,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,UAAU,CAAC,CAAA;QAE/E,mDAAmD;QACnD,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YAClC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;YAClD,oCAAoC;QACtC,CAAC,CAAC,CAAA;QACF,MAAM,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QAChC,8CAA8C;QAE9C,mDAAmD;QACnD,qDAAqD;QACrD,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,YAAY,EAAE,oCAAoC,wBAAY,KAAK,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,UAAU,CAAC,CAAA;QAC7G,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,SAAS,EAAE,sCAAsC,wBAAY,KAAK,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,UAAU,CAAC,CAAA;QAC7G,CAAC,CAAC,GAAG,EAAE,CAAA;IACT,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;IAEjB,yDAAyD;IACzD,CAAC,CAAC,IAAI,CAAC,gBAAgB,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;QACnC,MAAM,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,CAAC,OAAO,EAAE,CAAA;QACnC,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,EAAE,CAAA;QAC7B,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,EAAE,CAAA;QAE9B,iFAAiF;QACjF,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACxB,MAAM,MAAM,GAAG,MAAM,gBAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAA;QAEpD,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QACpD,wBAAwB;QACxB,yDAAyD;QACzD,KAAK;QACL,+BAA+B;QAC/B,6DAA6D;QAC7D,KAAK;QAEL,MAAM,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QAEhC,mDAAmD;QACnD,qDAAqD;QACrD,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,UAAU,EAAE,uBAAuB,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,UAAU,CAAC,CAAA;QAC7E,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,SAAS,EAAE,yBAAyB,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,UAAU,CAAC,CAAA;QAE/E,mDAAmD;QACnD,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YAClC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;YAClD,oCAAoC;QACtC,CAAC,CAAC,CAAA;QACF,MAAM,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QAChC,8CAA8C;QAE9C,mDAAmD;QACnD,qDAAqD;QACrD,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,kCAAkC,wBAAY,KAAK,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,UAAU,CAAC,CAAA;QAC1G,CAAC,CAAC,GAAG,EAAE,CAAA;IACT,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;IAEjB,yDAAyD;IACzD,CAAC,CAAC,IAAI,CAAC,sBAAsB,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;QACzC,MAAM,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,CAAC,KAAK,EAAE,CAAA;QACjC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,EAAE,CAAA;QAE9B,iFAAiF;QACjF,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACxB,MAAM,OAAO,GAAG,gBAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;QACpC,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;QAErC,MAAM,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QAChC,qDAAqD;QACrD,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,kCAAkC,wBAAY,KAAK,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,UAAU,CAAC,CAAA;QAC1G,CAAC,CAAC,GAAG,EAAE,CAAA;IACT,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;AACnB,CAAC,CAAC,CAAA"}

package/dist/esm/src/config.d.ts

@@ -0,0 +1,4 @@
+/// <reference path="../../../src/typings.d.ts" />
+export { VERSION } from './version.js';
+export declare const HTTP_TIMEOUT: number;
+//# sourceMappingURL=config.d.ts.map

package/dist/esm/src/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/config.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAEtC,eAAO,MAAM,YAAY,QACX,CAAA"}

package/dist/esm/src/config.js

@@ -0,0 +1,5 @@
+/// <reference path="./typings.d.ts" />
+export { VERSION } from './version.js';
+export const HTTP_TIMEOUT = Number(process.env['FILEBOX_HTTP_TIMEOUT'])
+    || 60 * 1000;
+//# sourceMappingURL=config.js.map

package/dist/esm/src/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/config.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAEtC,MAAM,CAAC,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;OAClE,EAAE,GAAG,IAAI,CAAA"}

package/dist/esm/src/file-box.d.ts

@@ -0,0 +1,209 @@
+/**
+ * File Box
+ * https://github.com/huan/file-box
+ *
+ * 2018 Huan LI <zixia@zixia.net>
+ */
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import type * as HTTP from 'http';
+import { Readable, Writable } from 'stream';
+import { FileBoxJsonObject, FileBoxOptions, FileBoxType, Metadata, Pipeable, UuidLoader, UuidSaver } from './file-box.type.js';
+import type { FileBoxInterface } from './interface.js';
+declare class FileBox implements Pipeable, FileBoxInterface {
+    /**
+     *
+     * Static Properties
+     *
+     */
+    static readonly version: string;
+    /**
+     * Symbol.hasInstance: instanceof
+     *
+     * @link https://www.keithcirkel.co.uk/metaprogramming-in-es6-symbols/
+     */
+    static [Symbol.hasInstance](lho: any): lho is FileBoxInterface;
+    /**
+     * Check if obj satisfy FileBox interface
+     */
+    static valid(target: any): target is FileBoxInterface;
+    /**
+     * Check if obj satisfy FileBox interface
+     */
+    static validInterface(target: any): target is FileBoxInterface;
+    /**
+     * loose check instance of FileBox
+     */
+    static validInstance(target: any): target is FileBox;
+    static fromUrl(url: string, options?: {
+        headers?: HTTP.OutgoingHttpHeaders;
+        name?: string;
+        size?: number;
+        md5?: string;
+    }): FileBox;
+    /**
+     * @deprecated use `fromUrl(url, options)` instead
+     */
+    static fromUrl(url: string, name?: string, headers?: HTTP.OutgoingHttpHeaders): FileBox;
+    /**
+     * Alias for `FileBox.fromFile()`
+     *
+     * @alias fromFile
+     */
+    static fromFile(path: string, name?: string, md5?: string): FileBox;
+    /**
+     * TODO: add `FileBoxStreamOptions` with `size` support (@huan, 202111)
+     */
+    static fromStream(stream: Readable, name?: string, md5?: string): FileBox;
+    static fromBuffer(buffer: Buffer, name?: string, md5?: string): FileBox;
+    /**
+     * @param base64
+     * @param name the file name of the base64 data
+     */
+    static fromBase64(base64: string, name?: string, md5?: string): FileBox;
+    /**
+     * dataURL: `data:image/png;base64,${base64Text}`,
+     */
+    static fromDataURL(dataUrl: string, name?: string, md5?: string): FileBox;
+    /**
+     *
+     * @param qrCode the value of the QR Code. For example: `https://github.com`
+     */
+    static fromQRCode(qrCode: string, md5?: string): FileBox;
+    protected static uuidToStream?: UuidLoader;
+    protected static uuidFromStream?: UuidSaver;
+    static fromUuid(uuid: string, options?: {
+        name?: string;
+        size?: number;
+        md5?: string;
+    }): FileBox;
+    /**
+     * @deprecated use `fromUuid(name, options)` instead
+     */
+    static fromUuid(uuid: string, name?: string, md5?: string): FileBox;
+    /**
+     * UUID Type FielBox Loader
+     */
+    static setUuidLoader(loader: UuidLoader): void;
+    /**
+     * UUID Type FielBox Saver
+     */
+    static setUuidSaver(saver: UuidSaver): void;
+    /**
+     *
+     * @static
+     * @param {(FileBoxJsonObject | string)} obj
+     * @returns {FileBox}
+     */
+    static fromJSON(obj: FileBoxJsonObject | string): FileBox;
+    /**
+     *
+     * Instance Properties
+     *
+     */
+    readonly version: string;
+    /**
+     * We are using a getter for `type` is because
+     *  getter name can be enumurated by the `Object.hasOwnProperties()`*
+     *    but property name can not.
+     *
+     *  * required by `validInterface()`
+     */
+    readonly _type: FileBoxType;
+    get type(): FileBoxType;
+    /**
+     * the Content-Length of the file
+     *  `SIZE_UNKNOWN(-1)` means unknown
+     *
+     * @example
+     * ```ts
+     * const fileBox = FileBox.fromUrl('http://example.com/image.png')
+     * await fileBox.ready()
+     * console.log(fileBox.size)
+     * // > 102400 <- this is the size of the remote image.png
+     * ```
+     */
+    _size?: number;
+    get size(): number;
+    /**
+     * File MD5 Sum
+     */
+    readonly md5: undefined | string;
+    /**
+     * @deprecated: use `mediaType` instead. will be removed after Dec 31, 2022
+     */
+    mimeType: string;
+    /**
+     * (Internet) Media Type is the proper technical term of `MIME Type`
+     *  @see https://stackoverflow.com/a/9277778/1123955
+     *
+     * @example 'text/plain'
+     */
+    protected _mediaType?: string;
+    get mediaType(): string;
+    protected _name: string;
+    get name(): string;
+    protected _metadata?: Metadata;
+    get metadata(): Metadata;
+    set metadata(data: Metadata);
+    /**
+     * Lazy load data: (can be serialized to JSON)
+     *  Do not read file to Buffer until there's a consumer.
+     */
+    private readonly base64?;
+    private readonly remoteUrl?;
+    private readonly qrCode?;
+    private readonly uuid?;
+    /**
+     * Can not be serialized to JSON
+     */
+    private readonly buffer?;
+    private readonly localPath?;
+    private readonly stream?;
+    private readonly headers?;
+    constructor(options: FileBoxOptions);
+    ready(): Promise<void>;
+    /**
+     * @todo use http.get/gets instead of Request
+     */
+    protected _syncUrlMetadata(): Promise<void>;
+    /**
+     *
+     * toXXX methods
+     *
+     */
+    toString(): string;
+    toJSON(): FileBoxJsonObject;
+    toStream(): Promise<Readable>;
+    /**
+     * https://stackoverflow.com/a/16044400/1123955
+     */
+    private _transformBufferToStream;
+    private _transformBase64ToStream;
+    private _transformFileToStream;
+    private _transformUrlToStream;
+    private _transformQRCodeToStream;
+    /**
+     * save file
+     *
+     * @param filePath save file
+     */
+    toFile(filePath?: string, overwrite?: boolean): Promise<void>;
+    toBase64(): Promise<string>;
+    /**
+     * dataUrl: `data:image/png;base64,${base64Text}',
+     */
+    toDataURL(): Promise<string>;
+    toBuffer(): Promise<Buffer>;
+    toQRCode(): Promise<string>;
+    toUuid(): Promise<string>;
+    /**
+     *
+     * toXXX methods END
+     *
+     */
+    pipe<T extends Writable>(destination: T): T;
+}
+export { FileBox, };
+//# sourceMappingURL=file-box.d.ts.map

package/dist/esm/src/file-box.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-box.d.ts","sourceRoot":"","sources":["../../../src/file-box.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;;;;AAIH,OAAO,KAAK,KAAK,IAAI,MAAM,MAAM,CAAA;AAMjC,OAAO,EAEL,QAAQ,EACR,QAAQ,EACT,MAA8B,QAAQ,CAAA;AAUvC,OAAO,EACL,iBAAiB,EACjB,cAAc,EAMd,WAAW,EACX,QAAQ,EACR,QAAQ,EACR,UAAU,EACV,SAAS,EACV,MAA8B,oBAAoB,CAAA;AAenD,OAAO,KAAK,EACV,gBAAgB,EACjB,MAA8B,gBAAgB,CAAA;AAQ/C,cAAM,OAAQ,YAAW,QAAQ,EAAE,gBAAgB;IAEjD;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,OAAO,SAAU;IAEjC;;;;OAIG;IACH,MAAM,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAE,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,gBAAgB;IAI/D;;OAEG;IACH,MAAM,CAAC,KAAK,CAAE,MAAM,EAAE,GAAG,GAAG,MAAM,IAAI,gBAAgB;IAItD;;OAEG;IACH,MAAM,CAAC,cAAc,CAAE,MAAM,EAAE,GAAG,GAAG,MAAM,IAAI,gBAAgB;IAI/D;;OAEG;IACH,MAAM,CAAC,aAAa,CAAE,MAAM,EAAE,GAAG,GAAG,MAAM,IAAI,OAAO;IAIrD,MAAM,CAAC,OAAO,CACZ,GAAG,EAAQ,MAAM,EACjB,OAAO,CAAC,EAAG;QACT,OAAO,CAAC,EAAG,IAAI,CAAC,mBAAmB,CAAC;QACpC,IAAI,CAAC,EAAM,MAAM,CAAC;QAClB,IAAI,CAAC,EAAM,MAAM,CAAC;QAClB,GAAG,CAAC,EAAO,MAAM,CAAC;KACnB,GACA,OAAO;IAEV;;OAEG;IACH,MAAM,CAAC,OAAO,CACZ,GAAG,EAAQ,MAAM,EACjB,IAAI,CAAC,EAAM,MAAM,EACjB,OAAO,CAAC,EAAG,IAAI,CAAC,mBAAmB,GAClC,OAAO;IA2CV;;;;OAIG;IAEH,MAAM,CAAC,QAAQ,CACb,IAAI,EAAI,MAAM,EACd,IAAI,CAAC,EAAG,MAAM,EACd,GAAG,CAAC,EAAK,MAAM,GACd,OAAO;IAcV;;OAEG;IACH,MAAM,CAAC,UAAU,CACf,MAAM,EAAE,QAAQ,EAChB,IAAI,CAAC,EAAG,MAAM,EACd,GAAG,CAAC,EAAI,MAAM,GACb,OAAO;IAUV,MAAM,CAAC,UAAU,CACf,MAAM,EAAE,MAAM,EACd,IAAI,CAAC,EAAI,MAAM,EACf,GAAG,CAAC,EAAK,MAAM,GACd,OAAO;IAUV;;;OAGG;IACH,MAAM,CAAC,UAAU,CACf,MAAM,EAAE,MAAM,EACd,IAAI,CAAC,EAAI,MAAM,EACf,GAAG,CAAC,EAAK,MAAM,GACd,OAAO;IAUV;;OAEG;IACH,MAAM,CAAC,WAAW,CAChB,OAAO,EAAG,MAAM,EAChB,IAAI,CAAC,EAAM,MAAM,EACjB,GAAG,CAAC,EAAO,MAAM,GAChB,OAAO;IAQV;;;OAGG;IACH,MAAM,CAAC,UAAU,CACf,MAAM,EAAE,MAAM,EACd,GAAG,CAAC,EAAI,MAAM,GACb,OAAO;IAUV,SAAS,CAAC,MAAM,CAAC,YAAY,CAAC,EAAK,UAAU,CAAA;IAC7C,SAAS,CAAC,MAAM,CAAC,cAAc,CAAC,EAAG,SAAS,CAAA;IAE5C,MAAM,CAAC,QAAQ,CACb,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,GAAG,CAAC,EAAG,MAAM,CAAC;KACf,GACA,OAAO;IAEV;;OAEG;IACH,MAAM,CAAC,QAAQ,CACb,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,MAAM,EACb,GAAG,CAAC,EAAE,MAAM,GACX,OAAO;IAoCV;;OAEG;IACH,MAAM,CAAC,aAAa,CAClB,MAAM,EAAE,UAAU,GACjB,IAAI;IAOP;;OAEG;IACH,MAAM,CAAC,YAAY,CACjB,KAAK,EAAE,SAAS,GACf,IAAI;IAOP;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAE,GAAG,EAAE,iBAAiB,GAAG,MAAM,GAAG,OAAO;IA6D1D;;;;OAIG;IACH,QAAQ,CAAC,OAAO,SAAU;IAE1B;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAA;IAC3B,IAAI,IAAI,gBAAyB;IAEjC;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,IAAI,IAAK,MAAM,CAKlB;IAED;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,SAAS,GAAG,MAAM,CAAA;IAEhC;;OAEG;IACH,QAAQ,SAAwB;IAEhC;;;;;OAKG;IACH,SAAS,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC7B,IAAI,SAAS,IAAK,MAAM,CAKvB;IAED,SAAS,CAAC,KAAK,EAAE,MAAM,CAAA;IACvB,IAAI,IAAI,IAAK,MAAM,CAElB;IAED,SAAS,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAA;IAC9B,IAAI,QAAQ,IAAK,QAAQ,CAKxB;IAED,IAAI,QAAQ,CAAE,IAAI,EAAE,QAAQ,EAM3B;IAED;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAY;IACpC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAY;IACpC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAc;IAEpC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAY;IACpC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAc;IAEtC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAA0B;gBAGjD,OAAO,EAAE,cAAc;IAuFnB,KAAK,IAAK,OAAO,CAAC,IAAI,CAAC;IAiB7B;;OAEG;cACa,gBAAgB,IAAK,OAAO,CAAC,IAAI,CAAC;IAkClD;;;;OAIG;IACH,QAAQ;IAUR,MAAM,IAAK,iBAAiB;IA4FtB,QAAQ,IAAK,OAAO,CAAC,QAAQ,CAAC;IAsEpC;;OAEG;IACH,OAAO,CAAC,wBAAwB;IAWhC,OAAO,CAAC,wBAAwB;IAQhC,OAAO,CAAC,sBAAsB;YAOhB,qBAAqB;YAYrB,wBAAwB;IAQtC;;;;OAIG;IACG,MAAM,CACV,QAAQ,CAAC,EAAE,MAAM,EACjB,SAAS,UAAQ,GAChB,OAAO,CAAC,IAAI,CAAC;IAoCV,QAAQ,IAAK,OAAO,CAAC,MAAM,CAAC;IAYlC;;OAEG;IACG,SAAS,IAAK,OAAO,CAAC,MAAM,CAAC;IAiB7B,QAAQ,IAAK,OAAO,CAAC,MAAM,CAAC;IAe5B,QAAQ,IAAK,OAAO,CAAC,MAAM,CAAC;IAc5B,MAAM,IAAK,OAAO,CAAC,MAAM,CAAC;IAoBhC;;;;OAIG;IAEH,IAAI,CAAC,CAAC,SAAS,QAAQ,EACrB,WAAW,EAAE,CAAC,GACb,CAAC;CAYL;AASD,OAAO,EACL,OAAO,GACR,CAAA"}