Skip to content

Commit

Permalink
Meta tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
sindresorhus committed Nov 22, 2017
1 parent dbdb12d commit 6ec6687
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 42 deletions.
76 changes: 38 additions & 38 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,40 +1,40 @@
{
"name": "gzip-size",
"version": "4.0.1",
"description": "Get the gzipped size of a string or buffer",
"license": "MIT",
"repository": "sindresorhus/gzip-size",
"author": {
"name": "Sindre Sorhus",
"email": "sindresorhus@gmail.com",
"url": "sindresorhus.com"
},
"engines": {
"node": ">=4"
},
"scripts": {
"test": "xo && ava"
},
"files": [
"index.js"
],
"keywords": [
"app",
"tool",
"zlib",
"gzip",
"compressed",
"size",
"string",
"buffer"
],
"dependencies": {
"duplexer": "^0.1.1",
"pify": "^3.0.0"
},
"devDependencies": {
"ava": "*",
"p-event": "^1.3.0",
"xo": "*"
}
"name": "gzip-size",
"version": "4.0.1",
"description": "Get the gzipped size of a string or buffer",
"license": "MIT",
"repository": "sindresorhus/gzip-size",
"author": {
"name": "Sindre Sorhus",
"email": "sindresorhus@gmail.com",
"url": "sindresorhus.com"
},
"engines": {
"node": ">=4"
},
"scripts": {
"test": "xo && ava"
},
"files": [
"index.js"
],
"keywords": [
"app",
"tool",
"zlib",
"gzip",
"compressed",
"size",
"string",
"buffer"
],
"dependencies": {
"duplexer": "^0.1.1",
"pify": "^3.0.0"
},
"devDependencies": {
"ava": "*",
"p-event": "^1.3.0",
"xo": "*"
}
}
8 changes: 4 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ console.log(gzipSize.sync(text));

## API

### gzipSize(input, options)
### gzipSize(input, [options])

Returns a `Promise` for the size.

### gzipSize.sync(input, options)
### gzipSize.sync(input, [options])

Returns the size.

Expand All @@ -44,11 +44,11 @@ Type: `Object`

Any [`zlib` option](https://nodejs.org/api/zlib.html#zlib_class_options).

### gzipSize.stream(options)
### gzipSize.stream([options])

Returns a [`stream.PassThrough`](https://nodejs.org/api/stream.html#stream_class_stream_passthrough). The stream emits a `gzip-size` event and has a `gzipSize` property.

### gzipSize.file(path, options)
### gzipSize.file(path, [options])

Returns a `Promise` for the size of the file.

Expand Down

0 comments on commit 6ec6687

Please sign in to comment.