Fixes for chunk utility documentation

octet-stream · octet-stream · commit d92c27b60d55 · 2023-05-23T20:04:47.000+03:00
diff --git a/src/util/chunk.ts b/src/util/chunk.ts
@@ -2,11 +2,11 @@ export const MAX_CHUNK_SIZE = 65536
 
 /**
  * Chunks given `value` into evenly sized pieces (Same as `MAX_CHUNK_SIZE` bytes per each).
- * Returns `Generator<Uint8Array>` allowing to iterate over these chunks.
+ * Returns `Generator<Uint8Array, void>` allowing to iterate over these chunks.
  *
- * If value is less then `MAX_CHUNK_SIZE`, it will be returned as-is.
+ * If the `value` <= `MAX_CHUNK_SIZE`, it will be returned as-is.
  *
- * If the last chunk is less than `MAX_CHUNK_SIZE`, then returned value will be the size that chunk.
+ * If the last chunk's size is less than `MAX_CHUNK_SIZE`, then returned value will be the size that chunk.
  *
  * @param value A value to chunk into evenly sized pieces
  *

Original file line number	Diff line number	Diff line change
`@@ -2,11 +2,11 @@ export const MAX_CHUNK_SIZE = 65536`
`2`	`2`
`3`	`3`	`/**`
`4`	`4`	* Chunks given `value` into evenly sized pieces (Same as `MAX_CHUNK_SIZE` bytes per each).
`5`		- * Returns `Generator<Uint8Array>` allowing to iterate over these chunks.
	`5`	+ * Returns `Generator<Uint8Array, void>` allowing to iterate over these chunks.
`6`	`6`	`*`
`7`		- * If value is less then `MAX_CHUNK_SIZE`, it will be returned as-is.
	`7`	+ * If the `value` <= `MAX_CHUNK_SIZE`, it will be returned as-is.
`8`	`8`	`*`
`9`		- * If the last chunk is less than `MAX_CHUNK_SIZE`, then returned value will be the size that chunk.
	`9`	+ * If the last chunk's size is less than `MAX_CHUNK_SIZE`, then returned value will be the size that chunk.
`10`	`10`	`*`
`11`	`11`	`* @param value A value to chunk into evenly sized pieces`
`12`	`12`	`*`