Browse Source

Add license, fix .npmignore

Arjun Barrett 4 years ago
parent
commit
1affe4fb6b
7 changed files with 46 additions and 22 deletions
  1. 7 5
      .npmignore
  2. 21 0
      LICENSE
  3. 7 7
      docs/README.md
  4. 2 2
      docs/interfaces/deflateoptions.md
  5. 4 4
      docs/interfaces/gzipoptions.md
  6. 2 2
      docs/interfaces/zliboptions.md
  7. 3 2
      package.json

+ 7 - 5
.npmignore

@@ -1,5 +1,7 @@
-*
-!lib/
-!esm/
-!package.json
-!README.md
+docs/
+src/
+.gitignore
+.npmignore
+tsconfig.esm.json
+tsconfig.json
+yarn.lock

+ 21 - 0
LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Arjun Barrett
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

+ 7 - 7
docs/README.md

@@ -24,7 +24,7 @@
 
 ▸ **decompress**(`data`: Uint8Array, `out?`: Uint8Array): Uint8Array
 
-*Defined in [index.ts:775](https://github.com/101arrowz/fflate/blob/fcabaac/src/index.ts#L775)*
+*Defined in [index.ts:774](https://github.com/101arrowz/fflate/blob/9ef7e32/src/index.ts#L774)*
 
 Expands compressed GZIP, Zlib, or raw DEFLATE data, automatically detecting the format
 
@@ -43,7 +43,7 @@ ___
 
 ▸ **deflate**(`data`: Uint8Array, `opts`: [DeflateOptions](interfaces/deflateoptions.md)): Uint8Array
 
-*Defined in [index.ts:681](https://github.com/101arrowz/fflate/blob/fcabaac/src/index.ts#L681)*
+*Defined in [index.ts:680](https://github.com/101arrowz/fflate/blob/9ef7e32/src/index.ts#L680)*
 
 Compresses data with DEFLATE without any wrapper
 
@@ -62,7 +62,7 @@ ___
 
 ▸ **gunzip**(`data`: Uint8Array, `out?`: Uint8Array): Uint8Array
 
-*Defined in [index.ts:721](https://github.com/101arrowz/fflate/blob/fcabaac/src/index.ts#L721)*
+*Defined in [index.ts:720](https://github.com/101arrowz/fflate/blob/9ef7e32/src/index.ts#L720)*
 
 Expands GZIP data
 
@@ -81,7 +81,7 @@ ___
 
 ▸ **gzip**(`data`: Uint8Array, `opts`: [GZIPOptions](interfaces/gzipoptions.md)): Uint8Array
 
-*Defined in [index.ts:701](https://github.com/101arrowz/fflate/blob/fcabaac/src/index.ts#L701)*
+*Defined in [index.ts:700](https://github.com/101arrowz/fflate/blob/9ef7e32/src/index.ts#L700)*
 
 Compresses data with GZIP
 
@@ -100,7 +100,7 @@ ___
 
 ▸ **inflate**(`data`: Uint8Array, `out?`: Uint8Array): Uint8Array
 
-*Defined in [index.ts:691](https://github.com/101arrowz/fflate/blob/fcabaac/src/index.ts#L691)*
+*Defined in [index.ts:690](https://github.com/101arrowz/fflate/blob/9ef7e32/src/index.ts#L690)*
 
 Expands DEFLATE data with no wrapper
 
@@ -119,7 +119,7 @@ ___
 
 ▸ **unzlib**(`data`: Uint8Array, `out?`: Uint8Array): Uint8Array
 
-*Defined in [index.ts:759](https://github.com/101arrowz/fflate/blob/fcabaac/src/index.ts#L759)*
+*Defined in [index.ts:758](https://github.com/101arrowz/fflate/blob/9ef7e32/src/index.ts#L758)*
 
 Expands Zlib data
 
@@ -138,7 +138,7 @@ ___
 
 ▸ **zlib**(`data`: Uint8Array, `opts`: [ZlibOptions](interfaces/zliboptions.md)): Uint8Array
 
-*Defined in [index.ts:738](https://github.com/101arrowz/fflate/blob/fcabaac/src/index.ts#L738)*
+*Defined in [index.ts:737](https://github.com/101arrowz/fflate/blob/9ef7e32/src/index.ts#L737)*
 
 Compress data with Zlib
 

+ 2 - 2
docs/interfaces/deflateoptions.md

@@ -23,7 +23,7 @@ Options for compressing data into a DEFLATE format
 
 • `Optional` **level**: 0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9
 
-*Defined in [index.ts:633](https://github.com/101arrowz/fflate/blob/fcabaac/src/index.ts#L633)*
+*Defined in [index.ts:632](https://github.com/101arrowz/fflate/blob/9ef7e32/src/index.ts#L632)*
 
 The level of compression to use, ranging from 0-9.
 
@@ -45,7 +45,7 @@ ___
 
 • `Optional` **mem**: 0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10 \| 11 \| 12
 
-*Defined in [index.ts:642](https://github.com/101arrowz/fflate/blob/fcabaac/src/index.ts#L642)*
+*Defined in [index.ts:641](https://github.com/101arrowz/fflate/blob/9ef7e32/src/index.ts#L641)*
 
 The memory level to use, ranging from 0-12. Increasing this increases speed and compression ratio at the cost of memory.
 

+ 4 - 4
docs/interfaces/gzipoptions.md

@@ -23,7 +23,7 @@ Options for compressing data into a GZIP format
 
 • `Optional` **filename**: string
 
-*Defined in [index.ts:658](https://github.com/101arrowz/fflate/blob/fcabaac/src/index.ts#L658)*
+*Defined in [index.ts:657](https://github.com/101arrowz/fflate/blob/9ef7e32/src/index.ts#L657)*
 
 The filename of the data. If the `gunzip` command is used to decompress the data, it will output a file
 with this name instead of the name of the compressed file.
@@ -36,7 +36,7 @@ ___
 
 *Inherited from [DeflateOptions](deflateoptions.md).[level](deflateoptions.md#level)*
 
-*Defined in [index.ts:633](https://github.com/101arrowz/fflate/blob/fcabaac/src/index.ts#L633)*
+*Defined in [index.ts:632](https://github.com/101arrowz/fflate/blob/9ef7e32/src/index.ts#L632)*
 
 The level of compression to use, ranging from 0-9.
 
@@ -60,7 +60,7 @@ ___
 
 *Inherited from [DeflateOptions](deflateoptions.md).[mem](deflateoptions.md#mem)*
 
-*Defined in [index.ts:642](https://github.com/101arrowz/fflate/blob/fcabaac/src/index.ts#L642)*
+*Defined in [index.ts:641](https://github.com/101arrowz/fflate/blob/9ef7e32/src/index.ts#L641)*
 
 The memory level to use, ranging from 0-12. Increasing this increases speed and compression ratio at the cost of memory.
 
@@ -75,7 +75,7 @@ ___
 
 • `Optional` **mtime**: Date \| string \| number
 
-*Defined in [index.ts:653](https://github.com/101arrowz/fflate/blob/fcabaac/src/index.ts#L653)*
+*Defined in [index.ts:652](https://github.com/101arrowz/fflate/blob/9ef7e32/src/index.ts#L652)*
 
 When the file was last modified. Defaults to the current time.
 Set this to 0 to avoid specifying a modification date entirely.

+ 2 - 2
docs/interfaces/zliboptions.md

@@ -23,7 +23,7 @@ Options for compressing data into a Zlib format
 
 *Inherited from [DeflateOptions](deflateoptions.md).[level](deflateoptions.md#level)*
 
-*Defined in [index.ts:633](https://github.com/101arrowz/fflate/blob/fcabaac/src/index.ts#L633)*
+*Defined in [index.ts:632](https://github.com/101arrowz/fflate/blob/9ef7e32/src/index.ts#L632)*
 
 The level of compression to use, ranging from 0-9.
 
@@ -47,7 +47,7 @@ ___
 
 *Inherited from [DeflateOptions](deflateoptions.md).[mem](deflateoptions.md#mem)*
 
-*Defined in [index.ts:642](https://github.com/101arrowz/fflate/blob/fcabaac/src/index.ts#L642)*
+*Defined in [index.ts:641](https://github.com/101arrowz/fflate/blob/9ef7e32/src/index.ts#L641)*
 
 The memory level to use, ranging from 0-12. Increasing this increases speed and compression ratio at the cost of memory.
 

+ 3 - 2
package.json

@@ -1,6 +1,6 @@
 {
   "name": "fflate",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "High performance (de)compression in an 8kB package",
   "main": "lib/index.js",
   "module": "esm/index.js",
@@ -15,7 +15,8 @@
     "inflate",
     "compression",
     "decompression",
-    "zlib"
+    "zlib",
+    "pako"
   ],
   "scripts": {
     "build": "tsc && tsc --project tsconfig.esm.json && typedoc --mode library --plugin typedoc-plugin-markdown --hideProjectName --hideBreadcrumbs --readme none",