GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — doc: fix the `crc32` documentation · nodejs/node@3943986

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

doc/api
- zlib.md

Expand file treeCollapse file tree

Open diff view settings

Collapse file

`‎doc/api/zlib.md‎`

Copy file name to clipboardExpand all lines: doc/api/zlib.md

+61-61Lines changed: 61 additions & 61 deletions

Display the source diff
Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -910,7 +910,67 @@ The `zlib.bytesWritten` property specifies the number of bytes written to
`910`	`910`	`the engine, before the bytes are processed (compressed or decompressed,`
`911`	`911`	`as appropriate for the derived class).`
`912`	`912`
`913`		-### `zlib.crc32(data[, value])`
	`913`	+### `zlib.close([callback])`
	`914`	`+`
	`915`	`+<!-- YAML`
	`916`	`+added: v0.9.4`
	`917`	`+-->`
	`918`	`+`
	`919`	+* `callback` {Function}
	`920`	`+`
	`921`	`+Close the underlying handle.`
	`922`	`+`
	`923`	+### `zlib.flush([kind, ]callback)`
	`924`	`+`
	`925`	`+<!-- YAML`
	`926`	`+added: v0.5.8`
	`927`	`+-->`
	`928`	`+`
	`929`	+* `kind` Default: `zlib.constants.Z_FULL_FLUSH` for zlib-based streams,
	`930`	+ `zlib.constants.BROTLI_OPERATION_FLUSH` for Brotli-based streams.
	`931`	+* `callback` {Function}
	`932`	`+`
	`933`	`+Flush pending data. Don't call this frivolously, premature flushes negatively`
	`934`	`+impact the effectiveness of the compression algorithm.`
	`935`	`+`
	`936`	+Calling this only flushes data from the internal `zlib` state, and does not
	`937`	`+perform flushing of any kind on the streams level. Rather, it behaves like a`
	`938`	+normal call to `.write()`, i.e. it will be queued up behind other pending
	`939`	`+writes and will only produce output when data is being read from the stream.`
	`940`	`+`
	`941`	+### `zlib.params(level, strategy, callback)`
	`942`	`+`
	`943`	`+<!-- YAML`
	`944`	`+added: v0.11.4`
	`945`	`+-->`
	`946`	`+`
	`947`	+* `level` {integer}
	`948`	+* `strategy` {integer}
	`949`	+* `callback` {Function}
	`950`	`+`
	`951`	`+This function is only available for zlib-based streams, i.e. not Brotli.`
	`952`	`+`
	`953`	`+Dynamically update the compression level and compression strategy.`
	`954`	`+Only applicable to deflate algorithm.`
	`955`	`+`
	`956`	+### `zlib.reset()`
	`957`	`+`
	`958`	`+<!-- YAML`
	`959`	`+added: v0.7.0`
	`960`	`+-->`
	`961`	`+`
	`962`	`+Reset the compressor/decompressor to factory defaults. Only applicable to`
	`963`	`+the inflate and deflate algorithms.`
	`964`	`+`
	`965`	+## `zlib.constants`
	`966`	`+`
	`967`	`+<!-- YAML`
	`968`	`+added: v7.0.0`
	`969`	`+-->`
	`970`	`+`
	`971`	`+Provides an object enumerating Zlib-related constants.`
	`972`	`+`
	`973`	+## `zlib.crc32(data[, value])`
`914`	`974`
`915`	`975`	`<!-- YAML`
`916`	`976`	`added:`
`@@ -973,66 +1033,6 @@ crc = zlib.crc32(Buffer.from('hello', 'utf16le')); // 1427272415`
`973`	`1033`	`crc = zlib.crc32(Buffer.from('world', 'utf16le'), crc); // 4150509955`
`974`	`1034`	```
`975`	`1035`
`976`		-### `zlib.close([callback])`
`977`		`-`
`978`		`-<!-- YAML`
`979`		`-added: v0.9.4`
`980`		`--->`
`981`		`-`
`982`		-* `callback` {Function}
`983`		`-`
`984`		`-Close the underlying handle.`
`985`		`-`
`986`		-### `zlib.flush([kind, ]callback)`
`987`		`-`
`988`		`-<!-- YAML`
`989`		`-added: v0.5.8`
`990`		`--->`
`991`		`-`
`992`		-* `kind` Default: `zlib.constants.Z_FULL_FLUSH` for zlib-based streams,
`993`		- `zlib.constants.BROTLI_OPERATION_FLUSH` for Brotli-based streams.
`994`		-* `callback` {Function}
`995`		`-`
`996`		`-Flush pending data. Don't call this frivolously, premature flushes negatively`
`997`		`-impact the effectiveness of the compression algorithm.`
`998`		`-`
`999`		-Calling this only flushes data from the internal `zlib` state, and does not
`1000`		`-perform flushing of any kind on the streams level. Rather, it behaves like a`
`1001`		-normal call to `.write()`, i.e. it will be queued up behind other pending
`1002`		`-writes and will only produce output when data is being read from the stream.`
`1003`		`-`
`1004`		-### `zlib.params(level, strategy, callback)`
`1005`		`-`
`1006`		`-<!-- YAML`
`1007`		`-added: v0.11.4`
`1008`		`--->`
`1009`		`-`
`1010`		-* `level` {integer}
`1011`		-* `strategy` {integer}
`1012`		-* `callback` {Function}
`1013`		`-`
`1014`		`-This function is only available for zlib-based streams, i.e. not Brotli.`
`1015`		`-`
`1016`		`-Dynamically update the compression level and compression strategy.`
`1017`		`-Only applicable to deflate algorithm.`
`1018`		`-`
`1019`		-### `zlib.reset()`
`1020`		`-`
`1021`		`-<!-- YAML`
`1022`		`-added: v0.7.0`
`1023`		`--->`
`1024`		`-`
`1025`		`-Reset the compressor/decompressor to factory defaults. Only applicable to`
`1026`		`-the inflate and deflate algorithms.`
`1027`		`-`
`1028`		-## `zlib.constants`
`1029`		`-`
`1030`		`-<!-- YAML`
`1031`		`-added: v7.0.0`
`1032`		`--->`
`1033`		`-`
`1034`		`-Provides an object enumerating Zlib-related constants.`
`1035`		`-`
`1036`	`1036`	## `zlib.createBrotliCompress([options])`
`1037`	`1037`
`1038`	`1038`	`<!-- YAML`

0 commit comments

Comments

0 (0)

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.