@naturalcycles/nodejs-lib 12.61.0 → 12.62.0

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

@@ -1,26 +1,26 @@
 /// <reference types="node" />
 import { ZlibOptions } from 'zlib';
 /**
- * zipBuffer uses `deflate`.
+ * deflateBuffer uses `deflate`.
  * It's 9 bytes shorter than `gzip`.
  */
-export declare function zipBuffer(buf: Buffer, options?: ZlibOptions): Promise<Buffer>;
+export declare function deflateBuffer(buf: Buffer, options?: ZlibOptions): Promise<Buffer>;
+export declare function inflateBuffer(buf: Buffer, options?: ZlibOptions): Promise<Buffer>;
+/**
+ * deflateString uses `deflate`.
+ * It's 9 bytes shorter than `gzip`.
+ */
+export declare function deflateString(s: string, options?: ZlibOptions): Promise<Buffer>;
+export declare function inflateToString(buf: Buffer, options?: ZlibOptions): Promise<string>;
 /**
  * gzipBuffer uses `gzip`
  * 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

@@ -1,21 +1,37 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.gunzipToString = exports.unzipToString = exports.gzipString = exports.zipString = exports.gunzipBuffer = exports.unzipBuffer = exports.gzipBuffer = exports.zipBuffer = void 0;
+exports.gunzipToString = exports.gzipString = exports.gunzipBuffer = exports.gzipBuffer = exports.inflateToString = exports.deflateString = exports.inflateBuffer = exports.deflateBuffer = void 0;
 const util_1 = require("util");
 const zlib = require("zlib");
 const deflate = (0, util_1.promisify)(zlib.deflate.bind(zlib));
 const inflate = (0, util_1.promisify)(zlib.inflate.bind(zlib));
 const gzip = (0, util_1.promisify)(zlib.gzip.bind(zlib));
 const gunzip = (0, util_1.promisify)(zlib.gunzip.bind(zlib));
-// string > zip
+// string > compressed buffer
 /**
- * zipBuffer uses `deflate`.
+ * deflateBuffer uses `deflate`.
  * It's 9 bytes shorter than `gzip`.
  */
-async function zipBuffer(buf, options = {}) {
+async function deflateBuffer(buf, options = {}) {
     return await deflate(buf, options);
 }
-exports.zipBuffer = zipBuffer;
+exports.deflateBuffer = deflateBuffer;
+async function inflateBuffer(buf, options = {}) {
+    return await inflate(buf, options);
+}
+exports.inflateBuffer = inflateBuffer;
+/**
+ * deflateString uses `deflate`.
+ * It's 9 bytes shorter than `gzip`.
+ */
+async function deflateString(s, options) {
+    return await deflateBuffer(Buffer.from(s), options);
+}
+exports.deflateString = deflateString;
+async function inflateToString(buf, options) {
+    return (await inflateBuffer(buf, options)).toString();
+}
+exports.inflateToString = inflateToString;
 /**
  * gzipBuffer uses `gzip`
  * It's 9 bytes longer than `deflate`.
@@ -24,23 +40,10 @@ async function gzipBuffer(buf, options = {}) {
     return await gzip(buf, options);
 }
 exports.gzipBuffer = gzipBuffer;
-// zip > buffer
-async function unzipBuffer(buf, options = {}) {
-    return await inflate(buf, options);
-}
-exports.unzipBuffer = unzipBuffer;
 async function gunzipBuffer(buf, options = {}) {
     return await gunzip(buf, options);
 }
 exports.gunzipBuffer = gunzipBuffer;
-/**
- * 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`.
@@ -49,11 +52,6 @@ async function gzipString(s, options) {
     return await gzipBuffer(Buffer.from(s), options);
 }
 exports.gzipString = gzipString;
-// convenience
-async function unzipToString(buf, options) {
-    return (await unzipBuffer(buf, options)).toString();
-}
-exports.unzipToString = unzipToString;
 async function gunzipToString(buf, options) {
     return (await gunzipBuffer(buf, options)).toString();
 }

package/package.json

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

package/src/util/zip.util.ts

@@ -7,16 +7,32 @@ const inflate = promisify(zlib.inflate.bind(zlib))
 const gzip = promisify(zlib.gzip.bind(zlib))
 const gunzip = promisify(zlib.gunzip.bind(zlib))
 
-// string > zip
+// string > compressed buffer
 
 /**
- * zipBuffer uses `deflate`.
+ * deflateBuffer uses `deflate`.
  * It's 9 bytes shorter than `gzip`.
  */
-export async function zipBuffer(buf: Buffer, options: ZlibOptions = {}): Promise<Buffer> {
+export async function deflateBuffer(buf: Buffer, options: ZlibOptions = {}): Promise<Buffer> {
   return await deflate(buf, options)
 }
 
+export async function inflateBuffer(buf: Buffer, options: ZlibOptions = {}): Promise<Buffer> {
+  return await inflate(buf, options)
+}
+
+/**
+ * deflateString uses `deflate`.
+ * It's 9 bytes shorter than `gzip`.
+ */
+export async function deflateString(s: string, options?: ZlibOptions): Promise<Buffer> {
+  return await deflateBuffer(Buffer.from(s), options)
+}
+
+export async function inflateToString(buf: Buffer, options?: ZlibOptions): Promise<string> {
+  return (await inflateBuffer(buf, options)).toString()
+}
+
 /**
  * gzipBuffer uses `gzip`
  * It's 9 bytes longer than `deflate`.
@@ -25,23 +41,10 @@ export async function gzipBuffer(buf: Buffer, options: ZlibOptions = {}): Promis
   return await gzip(buf, options)
 }
 
-// zip > buffer
-export async function unzipBuffer(buf: Buffer, options: ZlibOptions = {}): Promise<Buffer> {
-  return await inflate(buf, options)
-}
-
 export async function gunzipBuffer(buf: Buffer, options: ZlibOptions = {}): Promise<Buffer> {
   return await gunzip(buf, options)
 }
 
-/**
- * zipString uses `deflate`.
- * It's 9 bytes shorter than `gzip`.
- */
-export async function zipString(s: string, options?: ZlibOptions): Promise<Buffer> {
-  return await zipBuffer(Buffer.from(s), options)
-}
-
 /**
  * gzipString uses `gzip`.
  * It's 9 bytes longer than `deflate`.
@@ -50,11 +53,6 @@ export async function gzipString(s: string, options?: ZlibOptions): Promise<Buff
   return await gzipBuffer(Buffer.from(s), options)
 }
 
-// convenience
-export async function unzipToString(buf: Buffer, options?: ZlibOptions): Promise<string> {
-  return (await unzipBuffer(buf, options)).toString()
-}
-
 export async function gunzipToString(buf: Buffer, options?: ZlibOptions): Promise<string> {
   return (await gunzipBuffer(buf, options)).toString()
 }