0x5eal/rbxts-pako
1
0
Fork 0
mirror of https://github.com/0x5eal/rbxts-pako.git synced 2025-04-10 22:00:58 +01:00
Code Issues Projects Releases Packages Wiki Activity

Fixing documentation on direct functions (#253)

Browse source
This commit is contained in:
OrIOg 2022-05-11 16:48:34 +02:00 • committed by GitHub
parent 0398fad238
commit 8a3fa92fd1
Signed by: DevComp
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
lib/deflate.js
View file

@ -301,7 +301,7 @@ Deflate.prototype.onEnd = function (status) {
/** /**
* deflate(data[, options]) -> Uint8Array * deflate(data[, options]) -> Uint8Array
* - data (Uint8Array|String): input data to compress. * - data (Uint8Array|ArrayBuffer|String): input data to compress.
* - options (Object): zlib deflate options. * - options (Object): zlib deflate options.
* *
* Compress `data` with deflate algorithm and `options`. * Compress `data` with deflate algorithm and `options`.
@ -345,7 +345,7 @@ function deflate(input, options) {
/** /**
* deflateRaw(data[, options]) -> Uint8Array * deflateRaw(data[, options]) -> Uint8Array
* - data (Uint8Array|String): input data to compress. * - data (Uint8Array|ArrayBuffer|String): input data to compress.
* - options (Object): zlib deflate options. * - options (Object): zlib deflate options.
* *
* The same as [[deflate]], but creates raw data, without wrapper * The same as [[deflate]], but creates raw data, without wrapper
@ -360,7 +360,7 @@ function deflateRaw(input, options) {
/** /**
* gzip(data[, options]) -> Uint8Array * gzip(data[, options]) -> Uint8Array
* - data (Uint8Array|String): input data to compress. * - data (Uint8Array|ArrayBuffer|String): input data to compress.
* - options (Object): zlib deflate options. * - options (Object): zlib deflate options.
* *
* The same as [[deflate]], but create gzip wrapper instead of * The same as [[deflate]], but create gzip wrapper instead of

6
lib/inflate.js
View file

@ -338,7 +338,7 @@ Inflate.prototype.onEnd = function (status) {
/** /**
* inflate(data[, options]) -> Uint8Array|String * inflate(data[, options]) -> Uint8Array|String
* - data (Uint8Array): input data to decompress. * - data (Uint8Array|ArrayBuffer): input data to decompress.
* - options (Object): zlib inflate options. * - options (Object): zlib inflate options.
* *
* Decompress `data` with inflate/ungzip and `options`. Autodetect * Decompress `data` with inflate/ungzip and `options`. Autodetect
@ -389,7 +389,7 @@ function inflate(input, options) {
/** /**
* inflateRaw(data[, options]) -> Uint8Array|String * inflateRaw(data[, options]) -> Uint8Array|String
* - data (Uint8Array): input data to decompress. * - data (Uint8Array|ArrayBuffer): input data to decompress.
* - options (Object): zlib inflate options. * - options (Object): zlib inflate options.
* *
* The same as [[inflate]], but creates raw data, without wrapper * The same as [[inflate]], but creates raw data, without wrapper
@ -404,7 +404,7 @@ function inflateRaw(input, options) {
/** /**
* ungzip(data[, options]) -> Uint8Array|String * ungzip(data[, options]) -> Uint8Array|String
* - data (Uint8Array): input data to decompress. * - data (Uint8Array|ArrayBuffer): input data to decompress.
* - options (Object): zlib inflate options. * - options (Object): zlib inflate options.
* *
* Just shortcut to [[inflate]], because it autodetects format * Just shortcut to [[inflate]], because it autodetects format