@ezs/basics 1.18.0 → 1.19.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.19.0](https://github.com/Inist-CNRS/ezs/compare/@ezs/basics@1.18.0...@ezs/basics@1.19.0) (2022-06-22)
+
+
+### Features
+
+* 🎸 file save gz ([33df6cd](https://github.com/Inist-CNRS/ezs/commit/33df6cdc40af50c10511cca1449c5edb3a6878f2))
+
+
+
+
+
 # [1.18.0](https://github.com/Inist-CNRS/ezs/compare/@ezs/basics@1.17.1...@ezs/basics@1.18.0) (2022-06-21)
 
 

package/README.md

@@ -217,13 +217,14 @@ identifier = toto
 Output:
 
 ```json
-["/tmp/truc.json"]
+[{ filename: "/tmp/toto", size: XXX, ... }]
 ```
 
 #### Parameters
 
 -   `location` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Directory location (optional, default `TMPDIR`)
--   `identifier` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?** File name
+-   `identifier` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** File name
+-   `compress` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Enable gzip compression (optional, default `false`)
 
 Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 

package/lib/file-save.js

@@ -7,6 +7,8 @@ exports.default = FILESave;
 
 var _fs = require("fs");
 
+var _zlib = require("zlib");
+
 var _path = _interopRequireDefault(require("path"));
 
 var _os = require("os");
@@ -45,36 +47,47 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * Output:
  *
  * ```json
- * ["/tmp/truc.json"]
+ * [{ filename: "/tmp/toto", size: XXX, ... }]
  * ```
  *
  * @name FILESave
  * @param {String} [location=TMPDIR] Directory location
- * @param {Number} [identifier] File name
+ * @param {String} [identifier] File name
+ * @param {Boolean} [compress=false] Enable gzip compression
  * @returns {Object}
  */
 async function FILESave(data, feed) {
   if (!this.handle) {
     const identifier = String(this.getParam('identifier'));
     const location = this.getParam('location', (0, _os.tmpdir)());
+    const compress = this.getParam('compress', false);
 
     if (!_pathExists.default.sync(location)) {
       _makeDir.default.sync(location);
     }
 
-    this.filename = _path.default.resolve(location, identifier);
-    this.handle = (0, _fs.createWriteStream)(this.filename);
+    if (compress) {
+      this.filename = _path.default.resolve(location, `${identifier}.gz`);
+      this.handle = (0, _zlib.createGzip)();
+      this.handleEnd = this.handle.pipe((0, _fs.createWriteStream)(this.filename));
+    } else {
+      this.filename = _path.default.resolve(location, identifier);
+      this.handle = (0, _fs.createWriteStream)(this.filename);
+      this.handleEnd = this.handle;
+    }
   }
 
   if (this.isLast()) {
-    this.handle.close();
-    return (0, _fs.lstat)(this.filename, (err, stat) => {
-      feed.write({
-        filename: this.filename,
-        ...stat
+    this.handleEnd.on('close', () => {
+      (0, _fs.lstat)(this.filename, (err, stat) => {
+        feed.write({
+          filename: this.filename,
+          ...stat
+        });
+        return feed.close();
       });
-      return feed.close();
     });
+    return this.handle.end();
   }
 
   (0, _streamWrite.default)(this.handle, Buffer.from(String(data)), () => feed.end());

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ezs/basics",
   "description": "Basics statements for EZS",
-  "version": "1.18.0",
+  "version": "1.19.0",
   "author": "Nicolas Thouvenin <nthouvenin@gmail.com>",
   "bugs": "https://github.com/Inist-CNRS/ezs/issues",
   "dependencies": {
@@ -36,7 +36,7 @@
   "directories": {
     "test": "test"
   },
-  "gitHead": "346fbfb891990dda7dd2d445e1f32ab2276c7020",
+  "gitHead": "2003a35bd4f57965f324309db6cb0cb2afbeefbc",
   "homepage": "https://github.com/Inist-CNRS/ezs/tree/master/packages/basics#readme",
   "keywords": [
     "ezs"