zip-stream - npm Package Compare versions

Comparing version 0.8.0 to 1.0.0

package.json

 {
   "name": "zip-stream",
-  "version": "0.8.0",
+  "version": "1.0.0",
   "description": "a streaming zip archive generator.",
@@ -18,5 +18,5 @@ "homepage": "https://github.com/archiverjs/node-zip-stream",
   "license": "MIT",
-  "main": "lib/zip-stream.js",
+  "main": "index.js",
   "files": [
-    "lib"
+    "index.js"
   ],
@@ -27,15 +27,18 @@ "engines": {
   "scripts": {
-    "test": "mocha --reporter dot"
+    "test": "mocha --reporter dot",
+    "gendocs": "jsdoc -c jsdoc.json readme.md"
   },
   "dependencies": {
-    "archiver-utils": "~0.3.0",
-    "compress-commons": "~0.4.0",
-    "lodash": "~3.10.1",
-    "readable-stream": "~2.0.0"
+    "archiver-utils": "^1.0.0",
+    "compress-commons": "^1.0.0",
+    "lodash": "^4.8.0",
+    "readable-stream": "^2.0.0"
   },
   "devDependencies": {
-    "chai": "~3.4.0",
-    "mocha": "~2.3.3",
-    "rimraf": "~2.4.3",
-    "mkdirp": "~0.5.0"
+    "chai": "^3.4.0",
+    "jsdoc": "^3.4.0",
+    "minami": "^1.1.0",
+    "mocha": "^2.3.3",
+    "rimraf": "^2.4.3",
+    "mkdirp": "^0.5.0"
   },
@@ -42,0 +45,0 @@ "keywords": [

README.md

@@ -7,3 +7,3 @@ # zip-stream v0.8.0 [![Build Status](https://travis-ci.org/archiverjs/node-zip-stream.svg?branch=master)](https://travis-ci.org/archiverjs/node-zip-stream) [![Build status](https://ci.appveyor.com/api/projects/status/2sraarbaadwbtti2/branch/master?svg=true)](https://ci.appveyor.com/project/ctalkington/node-zip-stream/branch/master)
 
-[![NPM](https://nodei.co/npm/zip-stream.png)](https://nodei.co/npm/zip-stream/)
+Visit the [API documentation](http://archiverjs.com/zip-stream) for a list of all methods available.
 
@@ -44,56 +44,2 @@ ### Install
 
-### Instance API
-
-#### getBytesWritten()
-
-Returns the current number of bytes written to this stream.
-
-#### entry(input, data, callback(err, data))
-
-Appends an input source (text string, buffer, or stream) to the instance. When the instance has received, processed, and emitted the input, the callback is fired.
-
-#### finish()
-
-Finalizes the instance. You should listen to the destination stream's `end`/`close`/`finish` event to know when all output has been safely consumed. (`finalize` is aliased for back-compat)
-
-### Instance Options
-
-#### comment `string`
-
-Sets the zip comment.
-
-#### store `boolean`
-
-If true, all entry contents will be archived without compression by default.
-
-#### zlib `object`
-
-Passed to node's [zlib](http://nodejs.org/api/zlib.html#zlib_options) module to control compression. Options may vary by node version.
-
-### Entry Data
-
-#### name `string` `required`
-
-Sets the entry name including internal path.
-
-#### type `string`
-
-Sets the entry type. Defaults to `file` or `directory` if name ends with trailing slash.
-
-#### date `string|Date`
-
-Sets the entry date. This can be any valid date string or instance. Defaults to current time in locale.
-
-#### store `boolean`
-
-If true, entry contents will be archived without compression.
-
-#### comment `string`
-
-Sets the entry comment.
-
-#### mode `number`
-
-Sets the entry permissions.
-
 ## Things of Interest
@@ -103,3 +49,3 @@
 - [Contributing](https://github.com/archiverjs/node-zip-stream/blob/master/CONTRIBUTING.md)
-- [MIT License](https://github.com/archiverjs/node-zip-stream/blob/master/LICENSE-MIT)
+- [MIT License](https://github.com/archiverjs/node-zip-stream/blob/master/LICENSE)
 
@@ -106,0 +52,0 @@ ## Credits

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9015

increased by4.4%

Lines of code

130

increased by56.63%

Number of low quality alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

6

increased by50%

Number of lines in readme file

51

decreased by-51.43%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedarchiver-utils@1.3.0(transitive)

• + Addedbase64-js@1.5.1(transitive)

• + Addedbuffer@5.7.1(transitive)

• + Addedcompress-commons@1.2.2(transitive)

• + Addedcrc@3.8.0(transitive)

• + Addedcrc32-stream@2.0.0(transitive)

• + Addedfs.realpath@1.0.0(transitive)

• + Addedglob@7.2.3(transitive)

• + Addedgraceful-fs@4.2.11(transitive)

• + Addedieee754@1.2.1(transitive)

• + Addedlazystream@1.0.1(transitive)

• + Addedlodash@4.17.21(transitive)

• + Addednormalize-path@2.1.1(transitive)

• + Addedprocess-nextick-args@2.0.1(transitive)

• + Addedreadable-stream@2.3.8(transitive)

• + Addedremove-trailing-separator@1.1.0(transitive)

• + Addedsafe-buffer@5.1.2(transitive)

• + Addedstring_decoder@1.1.1(transitive)

• - Removedarchiver-utils@0.3.0(transitive)

• - Removedcompress-commons@0.4.2(transitive)

• - Removedcrc32-stream@0.4.0(transitive)

• - Removedglob@6.0.4(transitive)

• - Removedisarray@0.0.1(transitive)

• - Removedlazystream@0.1.0(transitive)

• - Removedlodash@3.10.1(transitive)

• - Removednode-int64@0.4.0(transitive)

• - Removednormalize-path@2.0.1(transitive)

• - Removedprocess-nextick-args@1.0.7(transitive)

• - Removedreadable-stream@1.0.342.0.6(transitive)

• - Removedstring_decoder@0.10.31(transitive)

• Updatedarchiver-utils@^1.0.0

• Updatedcompress-commons@^1.0.0

• Updatedlodash@^4.8.0

• Updatedreadable-stream@^2.0.0