Narrow Uint8Array type, close #307, #308

Author: puzrin

src/deflate.ts

@@ -121,7 +121,7 @@ class Deflate {
    * Chunks of output data, if {@link Deflate.onData} not overridden.
    * @internal
    */
-  chunks: Uint8Array[];
+  chunks: Uint8Array<ArrayBuffer>[];
 
   private strm: ZStream;
 
@@ -130,7 +130,7 @@ class Deflate {
    * and {@link Deflate.onEnd} handlers. Filled after you push last chunk
    * (call {@link Deflate.push} with {@link Z_FINISH} / `true` param).
    */
-  result: Uint8Array;
+  result: Uint8Array<ArrayBuffer>;
 
   /**
    * Creates a new deflator instance with the specified params. Throws an
@@ -320,7 +320,7 @@ class Deflate {
    * By default, stores data blocks in the {@link Deflate.chunks} property and glues
    * them in {@link Deflate.onEnd}. Override this handler if you need another behaviour.
    */
-  onData(chunk: Uint8Array): void {
+  onData(chunk: Uint8Array<ArrayBuffer>): void {
     this.chunks.push(chunk);
   }
 
@@ -355,7 +355,7 @@ class Deflate {
  * console.log(deflate(data))
  * ```
  */
-function deflate(input: DeflateInput, options: DeflateOptions = {}): Uint8Array {
+function deflate(input: DeflateInput, options: DeflateOptions = {}): Uint8Array<ArrayBuffer> {
   const deflator = new Deflate(options);
 
   deflator.push(input, true);
@@ -371,7 +371,7 @@ function deflate(input: DeflateInput, options: DeflateOptions = {}): Uint8Array
  * The same as {@link deflate}, but creates raw data without a wrapper
  * (header and adler32 crc).
  */
-function deflateRaw(input: DeflateInput, options: DeflateOptions = {}): Uint8Array {
+function deflateRaw(input: DeflateInput, options: DeflateOptions = {}): Uint8Array<ArrayBuffer> {
   return deflate(input, Object.assign({}, options, { raw: true }));
 }
 
@@ -380,7 +380,7 @@ function deflateRaw(input: DeflateInput, options: DeflateOptions = {}): Uint8Arr
  * The same as {@link deflate}, but creates a gzip wrapper instead of
  * a deflate one.
  */
-function gzip(input: DeflateInput, options: DeflateOptions = {}): Uint8Array {
+function gzip(input: DeflateInput, options: DeflateOptions = {}): Uint8Array<ArrayBuffer> {
   return deflate(input, Object.assign({}, options, { gzip: true }));
 }
 

src/inflate.ts

@@ -88,7 +88,7 @@ class Inflate {
    * Chunks of output data, if {@link Inflate.onData} not overridden.
    * @internal
    */
-  chunks: Uint8Array[];
+  chunks: Uint8Array<ArrayBuffer>[];
 
   private strm: ZStream;
 
@@ -97,7 +97,7 @@ class Inflate {
    * and {@link Inflate.onEnd} handlers. Filled after you push last chunk
    * (call {@link Inflate.push} with {@link Z_FINISH} / `true` param).
    */
-  result: Uint8Array;
+  result: Uint8Array<ArrayBuffer>;
 
   /**
    * Creates a new inflator instance with the specified params. Throws an
@@ -384,7 +384,7 @@ class Inflate {
    *
    * @param chunk output data.
    */
-  onData(chunk: Uint8Array): void {
+  onData(chunk: Uint8Array<ArrayBuffer>): void {
     this.chunks.push(chunk);
   }
 
@@ -429,7 +429,7 @@ class Inflate {
 function inflate<O extends InflateOptions & { toText?: boolean }>(
   input: InflateInput,
   options: O = {} as O
-): O extends { toText: true } ? string : Uint8Array {
+): O extends { toText: true } ? string : Uint8Array<ArrayBuffer> {
   const inflator = new Inflate(options);
 
   inflator.push(input, true);
@@ -440,7 +440,7 @@ function inflate<O extends InflateOptions & { toText?: boolean }>(
   const result = inflator.result;
 
   return (options.toText ? new TextDecoder().decode(result) : result) as
-    O extends { toText: true } ? string : Uint8Array;
+    O extends { toText: true } ? string : Uint8Array<ArrayBuffer>;
 }
 
 
@@ -451,7 +451,7 @@ function inflate<O extends InflateOptions & { toText?: boolean }>(
 function inflateRaw<O extends InflateOptions & { toText?: boolean }>(
   input: InflateInput,
   options: O = {} as O
-): O extends { toText: true } ? string : Uint8Array {
+): O extends { toText: true } ? string : Uint8Array<ArrayBuffer> {
   return inflate<O>(input, { ...options, raw: true } as O);
 }
 

src/utils.ts

@@ -1,5 +1,5 @@
 // Join array of chunks to single array.
-export const flattenChunks = (chunks: Uint8Array[]): Uint8Array => {
+export const flattenChunks = (chunks: Uint8Array<ArrayBuffer>[]): Uint8Array<ArrayBuffer> => {
   const result = new Uint8Array(chunks.reduce((len, chunk) => len + chunk.length, 0));
   let pos = 0;
 

src/zlib.d.mts

@@ -25,7 +25,7 @@ declare class ZStream {
   next_in: number;
   avail_in: number;
   total_in: number;
-  output: Uint8Array;
+  output: Uint8Array<ArrayBuffer>;
   next_out: number;
   avail_out: number;
   total_out: number;