@naturalcycles/nodejs-lib 12.59.0 → 12.60.0

package/dist/stream/ndjson/transformJsonParse.js

@@ -19,19 +19,19 @@ const stream_1 = require("stream");
 function transformJsonParse(opt = {}) {
     const { strict = true, reviver } = opt;
     return new stream_1.Transform({
-        objectMode: false,
+        writableObjectMode: false,
         readableObjectMode: true,
-        transform(chunk, _encoding, cb) {
+        transform(chunk, _, cb) {
             try {
                 const data = JSON.parse(chunk, reviver);
                 cb(null, data);
             }
             catch (err) {
-                // console.error(err)
                 if (strict) {
                     cb(err); // emit error
                 }
                 else {
+                    console.error(err);
                     cb(); // emit no error, but no result neither
                 }
             }

package/dist/stream/ndjson/transformToNDJson.js

@@ -9,9 +9,9 @@ const js_lib_1 = require("@naturalcycles/js-lib");
 function transformToNDJson(opt = {}) {
     const { strict = true, separator = '\n', sortObjects = false, useFlatstr = false } = opt;
     return new stream_1.Transform({
-        objectMode: true,
+        writableObjectMode: true,
         readableObjectMode: false,
-        transform(chunk, _encoding, cb) {
+        transform(chunk, _, cb) {
             try {
                 if (sortObjects) {
                     chunk = (0, js_lib_1._sortObjectDeep)(chunk);

package/dist/stream/sizeStack.d.ts

@@ -0,0 +1,9 @@
+import { CommonLogger, NumberStack } from '@naturalcycles/js-lib';
+export declare class SizeStack extends NumberStack {
+    name: string;
+    constructor(name: string, size: number);
+    total: number;
+    push(item: any): this;
+    getStats(): string;
+    static countItem(item: any, logger: CommonLogger, sizes?: SizeStack, sizesZipped?: SizeStack): Promise<void>;
+}

package/dist/stream/sizeStack.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SizeStack = void 0;
+const js_lib_1 = require("@naturalcycles/js-lib");
+const colors_1 = require("../colors");
+const zip_util_1 = require("../util/zip.util");
+class SizeStack extends js_lib_1.NumberStack {
+    constructor(name, size) {
+        super(size);
+        this.name = name;
+        this.total = 0;
+    }
+    push(item) {
+        this.total += item;
+        return super.push(item);
+    }
+    getStats() {
+        const pcs = this.percentiles([50, 90]);
+        return [
+            this.name,
+            'avg',
+            (0, colors_1.yellow)((0, js_lib_1._hb)(this.avg())),
+            'p50',
+            (0, colors_1.yellow)((0, js_lib_1._hb)(pcs[50])),
+            'p90',
+            (0, colors_1.yellow)((0, js_lib_1._hb)(pcs[90])),
+            'total',
+            (0, colors_1.yellow)((0, js_lib_1._hb)(this.total)),
+        ].join(' ');
+    }
+    static async countItem(item, logger, sizes, sizesZipped) {
+        if (!sizes)
+            return;
+        // try-catch, because we don't want to fail the pipeline on logProgress
+        try {
+            const buf = Buffer.from(JSON.stringify(item));
+            sizes.push(buf.byteLength);
+            if (sizesZipped) {
+                const { byteLength } = await (0, zip_util_1.gzipBuffer)(buf);
+                sizesZipped.push(byteLength);
+            }
+        }
+        catch (err) {
+            logger.warn(`transformLogProgress failed to JSON.stringify the chunk: ${err.message}`);
+        }
+    }
+}
+exports.SizeStack = SizeStack;

package/dist/stream/transform/transformBuffer.js

@@ -13,7 +13,7 @@ function transformBuffer(opt) {
     return new stream_1.Transform({
         objectMode: true,
         ...opt,
-        transform(chunk, _encoding, cb) {
+        transform(chunk, _, cb) {
             buf.push(chunk);
             if (buf.length >= batchSize) {
                 cb(null, buf);

package/dist/stream/transform/transformFilter.d.ts

@@ -1,11 +1,10 @@
 import { AsyncPredicate, Predicate } from '@naturalcycles/js-lib';
 import { TransformOptions, TransformTyped } from '../stream.model';
+import { TransformMapOptions } from './transformMap';
 /**
- * Note, that currently it's NOT concurrent! (concurrency = 1)
- * So, it's recommended to use transformMap instead, that is both concurrent and has
- * filtering feature by default.
+ * Just a convenience wrapper around `transformMap` that has built-in predicate filtering support.
  */
-export declare function transformFilter<IN = any>(predicate: AsyncPredicate<IN>, opt?: TransformOptions): TransformTyped<IN, IN>;
+export declare function transformFilter<IN = any>(predicate: AsyncPredicate<IN>, opt?: TransformMapOptions): TransformTyped<IN, IN>;
 /**
  * Sync version of `transformFilter`
  */

package/dist/stream/transform/transformFilter.js

@@ -2,29 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.transformFilterSync = exports.transformFilter = void 0;
 const stream_1 = require("stream");
+const transformMap_1 = require("./transformMap");
 /**
- * Note, that currently it's NOT concurrent! (concurrency = 1)
- * So, it's recommended to use transformMap instead, that is both concurrent and has
- * filtering feature by default.
+ * Just a convenience wrapper around `transformMap` that has built-in predicate filtering support.
  */
 function transformFilter(predicate, opt = {}) {
-    let index = 0;
-    return new stream_1.Transform({
-        objectMode: true,
+    return (0, transformMap_1.transformMap)(v => v, {
+        predicate,
         ...opt,
-        async transform(chunk, _encoding, cb) {
-            try {
-                if (await predicate(chunk, index++)) {
-                    cb(null, chunk); // pass through
-                }
-                else {
-                    cb(); // signal that we've finished processing, but emit no output here
-                }
-            }
-            catch (err) {
-                cb(err);
-            }
-        },
     });
 }
 exports.transformFilter = transformFilter;
@@ -36,7 +21,7 @@ function transformFilterSync(predicate, opt = {}) {
     return new stream_1.Transform({
         objectMode: true,
         ...opt,
-        async transform(chunk, _encoding, cb) {
+        transform(chunk, _, cb) {
             try {
                 if (predicate(chunk, index++)) {
                     cb(null, chunk); // pass through

package/dist/stream/transform/transformLogProgress.d.ts

@@ -84,6 +84,26 @@ export interface TransformLogProgressOptions<IN = any> extends TransformOptions
      * Defaults to 1.
      */
     batchSize?: number;
+    /**
+     * Experimental logging of item (shunk) sizes, when json-stringified.
+     *
+     * Defaults to false.
+     *
+     * @experimental
+     */
+    logSizes?: boolean;
+    /**
+     * How many last item sizes to keep in a buffer, to calculate stats (p50, p90, avg, etc).
+     * Defaults to 100_000.
+     * Cannot be Infinity.
+     */
+    logSizesBuffer?: number;
+    /**
+     * Works in addition to `logSizes`. Adds "zipped sizes".
+     *
+     * @experimental
+     */
+    logZippedSizes?: boolean;
 }
 /**
  * Pass-through transform that optionally logs progress.

package/dist/stream/transform/transformLogProgress.js

@@ -7,6 +7,7 @@ const js_lib_1 = require("@naturalcycles/js-lib");
 const time_lib_1 = require("@naturalcycles/time-lib");
 const colors_1 = require("../../colors");
 const colors_2 = require("../../colors/colors");
+const sizeStack_1 = require("../sizeStack");
 const inspectOpt = {
     colors: colors_2.hasColors,
     breakLength: 300,
@@ -15,7 +16,7 @@ const inspectOpt = {
  * Pass-through transform that optionally logs progress.
  */
 function transformLogProgress(opt = {}) {
-    const { metric = 'progress', heapTotal: logHeapTotal = false, heapUsed: logHeapUsed = false, rss: logRss = true, peakRSS: logPeakRSS = true, logRPS = true, logEvery = 1000, batchSize = 1, extra, logger = console, } = opt;
+    const { metric = 'progress', heapTotal: logHeapTotal = false, heapUsed: logHeapUsed = false, rss: logRss = true, peakRSS: logPeakRSS = true, logRPS = true, logEvery = 1000, logSizes = false, logSizesBuffer = 100000, logZippedSizes = false, batchSize = 1, extra, logger = console, } = opt;
     const logProgress = opt.logProgress !== false && logEvery !== 0; // true by default
     const logEvery10 = logEvery * 10;
     const started = Date.now();
@@ -24,13 +25,19 @@ function transformLogProgress(opt = {}) {
     let processedLastSecond = 0;
     let progress = 0;
     let peakRSS = 0;
+    const sizes = logSizes ? new sizeStack_1.SizeStack('json', logSizesBuffer) : undefined;
+    const sizesZipped = logZippedSizes ? new sizeStack_1.SizeStack('json.gz', logSizesBuffer) : undefined;
     logStats(); // initial
     return new stream_1.Transform({
         objectMode: true,
         ...opt,
-        transform(chunk, _encoding, cb) {
+        transform(chunk, _, cb) {
             progress++;
             processedLastSecond++;
+            if (sizes) {
+                // Check it, cause gzipping might be delayed here..
+                void sizeStack_1.SizeStack.countItem(chunk, logger, sizes, sizesZipped);
+            }
             if (logProgress && progress % logEvery === 0) {
                 logStats(chunk, false, progress % logEvery10 === 0);
             }
@@ -54,23 +61,34 @@ function transformLogProgress(opt = {}) {
         const rps10 = Math.round(sma.push(lastRPS));
         if (mem.rss > peakRSS)
             peakRSS = mem.rss;
-        logger.log((0, util_1.inspect)({
+        const o = {
             [final ? `${metric}_final` : metric]: batchedProgress,
-            ...(extra ? extra(chunk, progress) : {}),
-            ...(logHeapUsed ? { heapUsed: (0, js_lib_1._mb)(mem.heapUsed) } : {}),
-            ...(logHeapTotal ? { heapTotal: (0, js_lib_1._mb)(mem.heapTotal) } : {}),
-            ...(logRss ? { rss: (0, js_lib_1._mb)(mem.rss) } : {}),
-            ...(logPeakRSS ? { peakRSS: (0, js_lib_1._mb)(peakRSS) } : {}),
-            ...(opt.rssMinusHeap ? { rssMinusHeap: (0, js_lib_1._mb)(mem.rss - mem.heapTotal) } : {}),
-            ...(opt.external ? { external: (0, js_lib_1._mb)(mem.external) } : {}),
-            ...(opt.arrayBuffers ? { arrayBuffers: (0, js_lib_1._mb)(mem.arrayBuffers || 0) } : {}),
-            ...(logRPS
-                ? {
-                    rps10,
-                    rpsTotal,
-                }
-                : {}),
-        }, inspectOpt));
+        };
+        if (extra)
+            Object.assign(o, extra(chunk, progress));
+        if (logHeapUsed)
+            o.heapUsed = (0, js_lib_1._mb)(mem.heapUsed);
+        if (logHeapTotal)
+            o.heapTotal = (0, js_lib_1._mb)(mem.heapTotal);
+        if (logRss)
+            o.rss = (0, js_lib_1._mb)(mem.rss);
+        if (logPeakRSS)
+            o.peakRSS = (0, js_lib_1._mb)(peakRSS);
+        if (opt.rssMinusHeap)
+            o.rssMinusHeap = (0, js_lib_1._mb)(mem.rss - mem.heapTotal);
+        if (opt.external)
+            o.external = (0, js_lib_1._mb)(mem.external);
+        if (opt.arrayBuffers)
+            o.arrayBuffers = (0, js_lib_1._mb)(mem.arrayBuffers || 0);
+        if (logRPS)
+            Object.assign(o, { rps10, rpsTotal });
+        logger.log((0, util_1.inspect)(o, inspectOpt));
+        if (sizes?.items.length) {
+            logger.log(sizes.getStats());
+            if (sizesZipped?.items.length) {
+                logger.log(sizesZipped.getStats());
+            }
+        }
         if (tenx) {
             let perHour = Math.round((batchedProgress * 1000 * 60 * 60) / (now - started)) || 0;
             if (perHour > 900) {

package/dist/stream/transform/transformMap.d.ts

@@ -11,9 +11,8 @@ export interface TransformMapOptions<IN = any, OUT = IN> {
      * Predicate to filter outgoing results (after mapper).
      * Allows to not emit all results.
      *
-     * Set to `r => r` (passthrough predicate) to pass ANY value (including undefined/null)
-     *
-     * @default to filter out undefined/null values, but pass anything else
+     * Defaults to "pass everything" (including null, undefined, etc).
+     * Simpler way to exclude certain cases is to return SKIP symbol from the mapper.
      */
     predicate?: AsyncPredicate<OUT>;
     /**
@@ -39,7 +38,6 @@ export interface TransformMapOptions<IN = any, OUT = IN> {
     metric?: string;
     logger?: CommonLogger;
 }
-export declare function notNullishPredicate(item: any): boolean;
 /**
  * Like pMap, but for streams.
  * Inspired by `through2`.

package/dist/stream/transform/transformMap.js

@@ -1,14 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.transformMap = exports.notNullishPredicate = void 0;
+exports.transformMap = void 0;
 const js_lib_1 = require("@naturalcycles/js-lib");
 const through2Concurrent = require("through2-concurrent");
 const colors_1 = require("../../colors");
 const stream_util_1 = require("../stream.util");
-function notNullishPredicate(item) {
-    return item !== undefined && item !== null;
-}
-exports.notNullishPredicate = notNullishPredicate;
 // doesn't work, cause here we don't construct our Transform instance ourselves
 // export class TransformMap extends AbortableTransform {}
 /**
@@ -24,7 +20,8 @@ exports.notNullishPredicate = notNullishPredicate;
  * If an Array is returned by `mapper` - it will be flattened and multiple results will be emitted from it. Tested by Array.isArray().
  */
 function transformMap(mapper, opt = {}) {
-    const { concurrency = 16, predicate = notNullishPredicate, errorMode = js_lib_1.ErrorMode.THROW_IMMEDIATELY, flattenArrayOutput, onError, metric = 'stream', logger = console, } = opt;
+    const { concurrency = 16, predicate, // we now default to "no predicate" (meaning pass-everything)
+    errorMode = js_lib_1.ErrorMode.THROW_IMMEDIATELY, flattenArrayOutput, onError, metric = 'stream', logger = console, } = opt;
     let index = -1;
     let isSettled = false;
     let errors = 0;
@@ -44,24 +41,22 @@ function transformMap(mapper, opt = {}) {
             }
         },
     }, async function transformMapFn(chunk, _, cb) {
-        index++;
-        // console.log({chunk, _encoding})
         // Stop processing if isSettled (either THROW_IMMEDIATELY was fired or END received)
         if (isSettled)
             return cb();
+        const currentIndex = ++index;
         try {
-            const currentIndex = index; // because we need to pass it to 2 functions - mapper and predicate. Refers to INPUT index (since it may return multiple outputs)
             const res = await mapper(chunk, currentIndex);
             const passedResults = await (0, js_lib_1.pFilter)(flattenArrayOutput && Array.isArray(res) ? res : [res], async (r) => {
                 if (r === js_lib_1.END) {
                     isSettled = true; // will be checked later
                     return false;
                 }
-                return r !== js_lib_1.SKIP && (await predicate(r, currentIndex));
+                return r !== js_lib_1.SKIP && (!predicate || (await predicate(r, currentIndex)));
             });
             passedResults.forEach(r => this.push(r));
             if (isSettled) {
-                logger.log(`transformMap END received at index ${index}`);
+                logger.log(`transformMap END received at index ${currentIndex}`);
                 (0, stream_util_1.pipelineClose)('transformMap', this, this.sourceReadable, this.streamDone, logger);
             }
             cb(); // done processing

package/dist/stream/transform/transformMapSimple.js

@@ -17,7 +17,7 @@ function transformMapSimple(mapper, opt = {}) {
     const { errorMode = js_lib_1.ErrorMode.THROW_IMMEDIATELY, logger = console } = opt;
     return new stream_1.Transform({
         objectMode: true,
-        transform(chunk, _encoding, cb) {
+        transform(chunk, _, cb) {
             try {
                 cb(null, mapper(chunk, ++index));
             }

package/dist/stream/transform/transformMapSync.d.ts

@@ -1,4 +1,5 @@
 import { CommonLogger, ErrorMode, Mapper, Predicate } from '@naturalcycles/js-lib';
+import { AbortableTransform } from '../pipeline/pipeline';
 import { TransformTyped } from '../stream.model';
 export interface TransformMapSyncOptions<IN = any, OUT = IN> {
     /**
@@ -14,9 +15,8 @@ export interface TransformMapSyncOptions<IN = any, OUT = IN> {
      * Predicate to filter outgoing results (after mapper).
      * Allows to not emit all results.
      *
-     * @default to filter out undefined/null values, but pass anything else
-     *
-     * Set to `r => r` (passthrough predicate) to pass ANY value (including undefined/null)
+     * Defaults to "pass everything".
+     * Simpler way to skip individual entries is to return SKIP symbol.
      */
     predicate?: Predicate<OUT>;
     /**
@@ -36,6 +36,8 @@ export interface TransformMapSyncOptions<IN = any, OUT = IN> {
     metric?: string;
     logger?: CommonLogger;
 }
+export declare class TransformMapSync extends AbortableTransform {
+}
 /**
  * Sync (not async) version of transformMap.
  * Supposedly faster, for cases when async is not needed.

package/dist/stream/transform/transformMapSync.js

@@ -1,42 +1,48 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.transformMapSync = void 0;
-const stream_1 = require("stream");
+exports.transformMapSync = exports.TransformMapSync = void 0;
 const js_lib_1 = require("@naturalcycles/js-lib");
 const colors_1 = require("../../colors");
-const transformMap_1 = require("./transformMap");
+const pipeline_1 = require("../pipeline/pipeline");
+const stream_util_1 = require("../stream.util");
+class TransformMapSync extends pipeline_1.AbortableTransform {
+}
+exports.TransformMapSync = TransformMapSync;
 /**
  * Sync (not async) version of transformMap.
  * Supposedly faster, for cases when async is not needed.
  */
 function transformMapSync(mapper, opt = {}) {
     let index = -1;
-    const { predicate = transformMap_1.notNullishPredicate, errorMode = js_lib_1.ErrorMode.THROW_IMMEDIATELY, flattenArrayOutput = false, onError, metric = 'stream', objectMode = true, logger = console, } = opt;
-    let isRejected = false;
+    const { predicate, // defaults to "no predicate" (pass everything)
+    errorMode = js_lib_1.ErrorMode.THROW_IMMEDIATELY, flattenArrayOutput = false, onError, metric = 'stream', objectMode = true, logger = console, } = opt;
+    let isSettled = false;
     let errors = 0;
     const collectedErrors = []; // only used if errorMode == THROW_AGGREGATED
-    return new stream_1.Transform({
+    return new TransformMapSync({
         objectMode,
         ...opt,
-        transform(chunk, _encoding, cb) {
-            // Stop processing if THROW_IMMEDIATELY mode is used
-            if (isRejected && errorMode === js_lib_1.ErrorMode.THROW_IMMEDIATELY) {
+        transform(chunk, _, cb) {
+            // Stop processing if isSettled
+            if (isSettled)
                 return cb();
-            }
+            const currentIndex = ++index;
             try {
-                if (!predicate(chunk, ++index)) {
-                    cb(); // signal that we've finished processing, but emit no output here
-                    return;
-                }
                 // map and pass through
-                const v = mapper(chunk, index);
-                if (flattenArrayOutput && Array.isArray(v)) {
-                    // Pass each item individually
-                    v.forEach(item => this.push(item));
-                }
-                else {
-                    cb(null, v);
+                const v = mapper(chunk, currentIndex);
+                const passedResults = (flattenArrayOutput && Array.isArray(v) ? v : [v]).filter(r => {
+                    if (r === js_lib_1.END) {
+                        isSettled = true; // will be checked later
+                        return false;
+                    }
+                    return r !== js_lib_1.SKIP && (!predicate || predicate(r, currentIndex));
+                });
+                passedResults.forEach(r => this.push(r));
+                if (isSettled) {
+                    logger.log(`transformMapSync END received at index ${currentIndex}`);
+                    (0, stream_util_1.pipelineClose)('transformMapSync', this, this.sourceReadable, this.streamDone, logger);
                 }
+                cb(); // done processing
             }
             catch (err) {
                 logger.error(err);
@@ -49,7 +55,7 @@ function transformMapSync(mapper, opt = {}) {
                     catch { }
                 }
                 if (errorMode === js_lib_1.ErrorMode.THROW_IMMEDIATELY) {
-                    isRejected = true;
+                    isSettled = true;
                     // Emit error immediately
                     return cb(err);
                 }

package/dist/stream/transform/transformNoOp.js

@@ -10,7 +10,7 @@ const stream_1 = require("stream");
 function transformNoOp() {
     return new stream_1.Transform({
         objectMode: true,
-        transform(chunk, _encoding, cb) {
+        transform(chunk, _, cb) {
             cb(null, chunk);
         },
     });

package/dist/stream/transform/transformTap.js

@@ -10,14 +10,14 @@ const stream_1 = require("stream");
  */
 function transformTap(fn, opt = {}) {
     const { logger = console } = opt;
-    let index = 0;
+    let index = -1;
     return new stream_1.Transform({
         objectMode: true,
         ...opt,
-        async transform(chunk, _encoding, cb) {
+        async transform(chunk, _, cb) {
             // console.log('tap', chunk)
             try {
-                await fn(chunk, index++);
+                await fn(chunk, ++index);
             }
             catch (err) {
                 logger.error(err);

package/dist/stream/transform/transformToArray.js

@@ -10,7 +10,7 @@ function transformToArray(opt = {}) {
     return new stream_1.Transform({
         objectMode: true,
         ...opt,
-        transform(chunk, _encoding, cb) {
+        transform(chunk, _, cb) {
             res.push(chunk);
             // callback to signal that we processed input, but not emitting any output
             cb();

package/dist/stream/transform/transformToString.js

@@ -15,8 +15,8 @@ function transformToString() {
     return new stream_1.Transform({
         objectMode: false,
         readableObjectMode: true,
-        transform(chunk, _encoding, cb) {
-            // console.log(`enc: ${_encoding}`, chunk.toString())
+        transform(chunk, _, cb) {
+            // console.log(`enc: ${_}`, chunk.toString())
             cb(null, chunk.toString());
         },
     });

package/dist/stream/transform/worker/transformMultiThreaded.js

@@ -71,7 +71,7 @@ function transformMultiThreaded(opt) {
                 cb(err);
             }
         },
-    }, async function transformMapFn(chunk, _encoding, cb) {
+    }, async function transformMapFn(chunk, _, cb) {
         // Freezing the index, because it may change due to concurrency
         const currentIndex = ++index;
         // Create the unresolved promise (to avait)

package/dist/stream/writable/writableFork.js

@@ -24,7 +24,7 @@ function writableFork(chains, opt) {
     return new stream_1.Writable({
         objectMode: true,
         ...opt,
-        write(chunk, _encoding, cb) {
+        write(chunk, _, cb) {
             // Push/fork to all sub-streams
             // No backpressure is ensured here, it'll push regardless of the
             readables.forEach(readable => readable.push(chunk));

package/dist/stream/writable/writablePushToArray.js

@@ -9,7 +9,7 @@ function writablePushToArray(arr, opt = {}) {
     return new stream_1.Writable({
         objectMode: true,
         ...opt,
-        write(chunk, _encoding, cb) {
+        write(chunk, _, cb) {
             arr.push(chunk);
             // callback to signal that we processed input, but not emitting any output
             cb();

package/dist/stream/writable/writableVoid.js

@@ -11,7 +11,7 @@ function writableVoid(opt = {}) {
     return new stream_1.Writable({
         objectMode: true,
         ...opt,
-        write(chunk, _encoding, cb) {
+        write(chunk, _, cb) {
             cb();
         },
         final(cb) {

package/dist/util/zip.util.d.ts

@@ -2,17 +2,25 @@
 import { ZlibOptions } from 'zlib';
 /**
  * zipBuffer uses `deflate`.
- * It's 9 bytes shorter than gzip.
+ * It's 9 bytes shorter than `gzip`.
  */
 export declare function zipBuffer(buf: Buffer, options?: ZlibOptions): Promise<Buffer>;
 /**
  * gzipBuffer uses `gzip`
- * It's 9 bytes longer than deflate.
+ * It's 9 bytes longer than `deflate`.
  */
 export declare function gzipBuffer(buf: Buffer, options?: ZlibOptions): Promise<Buffer>;
 export declare function unzipBuffer(buf: Buffer, options?: ZlibOptions): Promise<Buffer>;
 export declare function gunzipBuffer(buf: Buffer, options?: ZlibOptions): Promise<Buffer>;
+/**
+ * zipString uses `deflate`.
+ * It's 9 bytes shorter than `gzip`.
+ */
 export declare function zipString(s: string, options?: ZlibOptions): Promise<Buffer>;
+/**
+ * gzipString uses `gzip`.
+ * It's 9 bytes longer than `deflate`.
+ */
 export declare function gzipString(s: string, options?: ZlibOptions): Promise<Buffer>;
 export declare function unzipToString(buf: Buffer, options?: ZlibOptions): Promise<string>;
 export declare function gunzipToString(buf: Buffer, options?: ZlibOptions): Promise<string>;

package/dist/util/zip.util.js

@@ -10,7 +10,7 @@ const gunzip = (0, util_1.promisify)(zlib.gunzip.bind(zlib));
 // string > zip
 /**
  * zipBuffer uses `deflate`.
- * It's 9 bytes shorter than gzip.
+ * It's 9 bytes shorter than `gzip`.
  */
 async function zipBuffer(buf, options = {}) {
     return await deflate(buf, options);
@@ -18,7 +18,7 @@ async function zipBuffer(buf, options = {}) {
 exports.zipBuffer = zipBuffer;
 /**
  * gzipBuffer uses `gzip`
- * It's 9 bytes longer than deflate.
+ * It's 9 bytes longer than `deflate`.
  */
 async function gzipBuffer(buf, options = {}) {
     return await gzip(buf, options);
@@ -33,11 +33,18 @@ async function gunzipBuffer(buf, options = {}) {
     return await gunzip(buf, options);
 }
 exports.gunzipBuffer = gunzipBuffer;
-// convenience
+/**
+ * zipString uses `deflate`.
+ * It's 9 bytes shorter than `gzip`.
+ */
 async function zipString(s, options) {
     return await zipBuffer(Buffer.from(s), options);
 }
 exports.zipString = zipString;
+/**
+ * gzipString uses `gzip`.
+ * It's 9 bytes longer than `deflate`.
+ */
 async function gzipString(s, options) {
     return await gzipBuffer(Buffer.from(s), options);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/nodejs-lib",
-  "version": "12.59.0",
+  "version": "12.60.0",
   "scripts": {
     "prepare": "husky install",
     "docs-serve": "vuepress dev docs",