Skip to content

Commit

Permalink
Meta tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
sindresorhus committed Nov 16, 2020
1 parent 211169f commit 78ccb1d
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 10 deletions.
2 changes: 1 addition & 1 deletion license
@@ -1,6 +1,6 @@
MIT License

Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Expand Down
5 changes: 3 additions & 2 deletions package.json
Expand Up @@ -4,10 +4,11 @@
"description": "Get the gzipped size of a string or buffer",
"license": "MIT",
"repository": "sindresorhus/gzip-size",
"funding": "https://github.com/sponsors/sindresorhus",
"author": {
"name": "Sindre Sorhus",
"email": "sindresorhus@gmail.com",
"url": "sindresorhus.com"
"url": "https://sindresorhus.com"
},
"engines": {
"node": ">=10"
Expand All @@ -30,7 +31,7 @@
"buffer"
],
"dependencies": {
"duplexer": "^0.1.1"
"duplexer": "^0.1.2"
},
"devDependencies": {
"ava": "^2.4.0",
Expand Down
9 changes: 2 additions & 7 deletions readme.md
@@ -1,15 +1,13 @@
# gzip-size [![Build Status](https://travis-ci.org/sindresorhus/gzip-size.svg?branch=master)](https://travis-ci.org/sindresorhus/gzip-size)
# gzip-size [![Build Status](https://travis-ci.com/sindresorhus/gzip-size.svg?branch=master)](https://travis-ci.com/github/sindresorhus/gzip-size)

> Get the gzipped size of a string or buffer

## Install

```
$ npm install gzip-size
```


## Usage

```js
Expand All @@ -24,7 +22,6 @@ console.log(gzipSize.sync(text));
//=> 78
```


## API

### gzipSize(input, options?)
Expand All @@ -45,7 +42,7 @@ 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.

Expand All @@ -61,12 +58,10 @@ Type: `string`

Returns the size of the file.


## Related

- [gzip-size-cli](https://github.com/sindresorhus/gzip-size-cli) - CLI for this module


---

<div align="center">
Expand Down

0 comments on commit 78ccb1d

Please sign in to comment.