refactor(bytes,crypto,encoding,http,io,msgpack,streams,tar): make Uin…

…t8Array usages compatible with TS 5.7 (#6372)
denoland · Jan 31, 2025 · ace6a0e · ace6a0e
1 parent 61ee836
commit ace6a0e
Show file tree

Hide file tree

Showing 29 changed files with 118 additions and 29 deletions.
diff --git a/bytes/_types.ts b/bytes/_types.ts
@@ -0,0 +1,11 @@
+// Copyright 2018-2025 the Deno authors. MIT license.
+
+/**
+ * Proxy type of {@code Uint8Array<ArrayBuffer} or {@code Uint8Array} in TypeScript 5.7 or below respectively.
+ *
+ * This type is internal utility type and should not be used directly.
+ *
+ * @internal @private
+ */
+
+export type Uint8Array_ = ReturnType<Uint8Array["slice"]>;
diff --git a/bytes/concat.ts b/bytes/concat.ts
@@ -1,6 +1,9 @@
 // Copyright 2018-2025 the Deno authors. MIT license.
 // This module is browser compatible.
 
+import type { Uint8Array_ } from "./_types.ts";
+export type { Uint8Array_ };
+
 /**
  * Concatenate an array of byte slices into a single slice.
  *
@@ -18,7 +21,7 @@
  * assertEquals(concat([a, b]), new Uint8Array([0, 1, 2, 3, 4, 5]));
  * ```
  */
-export function concat(buffers: Uint8Array[]): Uint8Array {
+export function concat(buffers: Uint8Array[]): Uint8Array_ {
   let length = 0;
   for (const buffer of buffers) {
     length += buffer.length;

diff --git a/bytes/repeat.ts b/bytes/repeat.ts
@@ -1,6 +1,8 @@
 // Copyright 2018-2025 the Deno authors. MIT license.
 // This module is browser compatible.
 import { copy } from "./copy.ts";
+import type { Uint8Array_ } from "./_types.ts";
+export type { Uint8Array_ };
 
 /**
  * Returns a new byte slice composed of `count` repetitions of the `source`
@@ -31,7 +33,7 @@ import { copy } from "./copy.ts";
  * assertEquals(repeat(source, 0), new Uint8Array());
  * ```
  */
-export function repeat(source: Uint8Array, count: number): Uint8Array {
+export function repeat(source: Uint8Array, count: number): Uint8Array_ {
   if (count < 0 || !Number.isInteger(count)) {
     throw new RangeError("Count must be a non-negative integer");
   }

diff --git a/crypto/crypto.ts b/crypto/crypto.ts
@@ -241,7 +241,7 @@ const stdCrypto: StdCrypto = ((x) => x)({
             }
             context.update(chunkBytes);
           }
-          return context.digestAndDrop(length).buffer;
+          return context.digestAndDrop(length).buffer as ArrayBuffer;
         } else {
           throw new TypeError(
             "data must be a BufferSource or [Async]Iterable<BufferSource>",
@@ -265,7 +265,7 @@ const stdCrypto: StdCrypto = ((x) => x)({
       const wasmCrypto = instantiateWasm();
       if (isBufferSource(data)) {
         const bytes = toUint8Array(data)!;
-        return wasmCrypto.digest(name, bytes, length).buffer;
+        return wasmCrypto.digest(name, bytes, length).buffer as ArrayBuffer;
       }
       if (isIterable(data)) {
         const context = new wasmCrypto.DigestContext(name);
@@ -278,7 +278,7 @@ const stdCrypto: StdCrypto = ((x) => x)({
           }
           context.update(chunkBytes);
         }
-        return context.digestAndDrop(length).buffer;
+        return context.digestAndDrop(length).buffer as ArrayBuffer;
       }
       throw new TypeError(
         "data must be a BufferSource or Iterable<BufferSource>",

diff --git a/encoding/_base32_common.ts b/encoding/_base32_common.ts
@@ -7,6 +7,7 @@
  */
 
 import { validateBinaryLike } from "./_validate_binary_like.ts";
+import type { Uint8Array_ } from "./_types.ts";
 
 const placeHolderPadLookup = [0, 1, , 2, 3, , 4];
 
@@ -46,7 +47,10 @@ function getByteLength(validLen: number, placeHoldersLen: number): number {
  * @param lookup The lookup table
  * @returns The encoded string.
  */
-export function decode(b32: string, lookup: ReadonlyArray<string>): Uint8Array {
+export function decode(
+  b32: string,
+  lookup: ReadonlyArray<string>,
+): Uint8Array_ {
   const revLookup: number[] = [];
   lookup.forEach((c, i) => (revLookup[c.charCodeAt(0)] = i));
 

diff --git a/encoding/_types.ts b/encoding/_types.ts
@@ -0,0 +1,11 @@
+// Copyright 2018-2025 the Deno authors. MIT license.
+
+/**
+ * Proxy type of {@code Uint8Array<ArrayBuffer} or {@code Uint8Array} in TypeScript 5.7 or below respectively.
+ *
+ * This type is internal utility type and should not be used directly.
+ *
+ * @internal @private
+ */
+
+export type Uint8Array_ = ReturnType<Uint8Array["slice"]>;
diff --git a/encoding/ascii85.ts b/encoding/ascii85.ts
@@ -1,6 +1,9 @@
 // Copyright 2018-2025 the Deno authors. MIT license.
 // This module is browser compatible.
 
+import type { Uint8Array_ } from "./_types.ts";
+export type { Uint8Array_ };
+
 /**
  * Utilities for working with {@link https://en.wikipedia.org/wiki/Ascii85 | ascii85} encoding.
  *
@@ -156,7 +159,7 @@ export type DecodeAscii85Options = Omit<EncodeAscii85Options, "delimiter">;
 export function decodeAscii85(
   ascii85: string,
   options: DecodeAscii85Options = {},
-): Uint8Array {
+): Uint8Array_ {
   const { standard = "Adobe" } = options;
 
   // translate all encodings to most basic adobe/btoa one and decompress some special characters ("z" and "y")

diff --git a/encoding/base32.ts b/encoding/base32.ts
@@ -2,6 +2,9 @@
 // Copyright (c) 2014 Jameson Little. MIT License.
 // This module is browser compatible.
 
+import type { Uint8Array_ } from "./_types.ts";
+export type { Uint8Array_ };
+
 /**
  * Utilities for
  * {@link https://www.rfc-editor.org/rfc/rfc4648.html#section-6 | base32}
@@ -48,7 +51,7 @@ lookup.forEach((c, i) => (revLookup[c.charCodeAt(0)] = i));
  * );
  * ```
  */
-export function decodeBase32(b32: string): Uint8Array {
+export function decodeBase32(b32: string): Uint8Array_ {
   return decode(b32, lookup);
 }
 

diff --git a/encoding/base58.ts b/encoding/base58.ts
@@ -21,6 +21,8 @@
  */
 
 import { validateBinaryLike } from "./_validate_binary_like.ts";
+import type { Uint8Array_ } from "./_types.ts";
+export type { Uint8Array_ };
 
 // deno-fmt-ignore
 const mapBase58: Record<string, number> = {
@@ -120,7 +122,7 @@ export function encodeBase58(data: ArrayBuffer | Uint8Array | string): string {
  * );
  * ```
  */
-export function decodeBase58(b58: string): Uint8Array {
+export function decodeBase58(b58: string): Uint8Array_ {
   const splitInput = b58.trim().split("");
 
   let length = 0;

diff --git a/encoding/base58_test.ts b/encoding/base58_test.ts
@@ -53,7 +53,7 @@ Deno.test("encodeBase58() encodes binary", () => {
 
 Deno.test("encodeBase58() encodes binary buffer", () => {
   for (const [input, output] of testSetBinary) {
-    assertEquals(encodeBase58(input.buffer), output);
+    assertEquals(encodeBase58(input.buffer as ArrayBuffer), output);
   }
 });
 

diff --git a/encoding/base64.ts b/encoding/base64.ts
@@ -23,6 +23,8 @@
  */
 
 import { validateBinaryLike } from "./_validate_binary_like.ts";
+import type { Uint8Array_ } from "./_types.ts";
+export type { Uint8Array_ };
 
 const base64abc = [
   "A",
@@ -163,7 +165,7 @@ export function encodeBase64(data: ArrayBuffer | Uint8Array | string): string {
  * );
  * ```
  */
-export function decodeBase64(b64: string): Uint8Array {
+export function decodeBase64(b64: string): Uint8Array_ {
   const binString = atob(b64);
   const size = binString.length;
   const bytes = new Uint8Array(size);

diff --git a/encoding/base64_test.ts b/encoding/base64_test.ts
@@ -33,7 +33,7 @@ Deno.test("encodeBase64() encodes binary", () => {
 
 Deno.test("encodeBase64() encodes binary buffer", () => {
   for (const [input, output] of testsetBinary) {
-    assertEquals(encodeBase64(input.buffer), output);
+    assertEquals(encodeBase64(input.buffer as ArrayBuffer), output);
   }
 });
 

diff --git a/encoding/base64url.ts b/encoding/base64url.ts
@@ -10,6 +10,8 @@
  */
 
 import * as base64 from "./base64.ts";
+import type { Uint8Array_ } from "./_types.ts";
+export type { Uint8Array_ };
 
 /**
  * Some variants allow or require omitting the padding '=' signs:
@@ -83,6 +85,6 @@ export function encodeBase64Url(
  * );
  * ```
  */
-export function decodeBase64Url(b64url: string): Uint8Array {
+export function decodeBase64Url(b64url: string): Uint8Array_ {
   return base64.decodeBase64(convertBase64urlToBase64(b64url));
 }
diff --git a/encoding/hex.ts b/encoding/hex.ts
@@ -27,6 +27,8 @@
  */
 
 import { validateBinaryLike } from "./_validate_binary_like.ts";
+import type { Uint8Array_ } from "./_types.ts";
+export type { Uint8Array_ };
 
 const hexTable = new TextEncoder().encode("0123456789abcdef");
 const textEncoder = new TextEncoder();
@@ -100,7 +102,7 @@ export function encodeHex(src: string | Uint8Array | ArrayBuffer): string {
  * );
  * ```
  */
-export function decodeHex(src: string): Uint8Array {
+export function decodeHex(src: string): Uint8Array_ {
   const u8 = textEncoder.encode(src);
   const dst = new Uint8Array(u8.length / 2);
   for (let i = 0; i < dst.length; i++) {

diff --git a/encoding/unstable_base32_stream.ts b/encoding/unstable_base32_stream.ts
@@ -22,6 +22,8 @@
  */
 
 import { decodeBase32, encodeBase32 } from "./base32.ts";
+import type { Uint8Array_ } from "./_types.ts";
+export type { Uint8Array_ };
 
 /**
  * Converts a Uint8Array stream into a base32-encoded stream.
@@ -88,7 +90,7 @@ export class Base32EncoderStream extends TransformStream<Uint8Array, string> {
  * assertEquals(await toText(stream), "Hello World!");
  * ```
  */
-export class Base32DecoderStream extends TransformStream<string, Uint8Array> {
+export class Base32DecoderStream extends TransformStream<string, Uint8Array_> {
   constructor() {
     let push = "";
     super({

diff --git a/encoding/unstable_base32crockford.ts b/encoding/unstable_base32crockford.ts
@@ -24,6 +24,8 @@
  * @module
  */
 import { decode, encode } from "./_base32_common.ts";
+import type { Uint8Array_ } from "./_types.ts";
+export type { Uint8Array_ };
 
 const lookup: string[] = "0123456789ABCDEFGHJKMNPQRSTVWXYZ".split("");
 const revLookup: number[] = [];
@@ -48,7 +50,7 @@ lookup.forEach((c, i) => (revLookup[c.charCodeAt(0)] = i));
  * );
  * ```
  */
-export function decodeBase32Crockford(b32: string): Uint8Array {
+export function decodeBase32Crockford(b32: string): Uint8Array_ {
   return decode(b32, lookup);
 }
 

diff --git a/encoding/unstable_base32hex.ts b/encoding/unstable_base32hex.ts
@@ -28,6 +28,8 @@
  * @module
  */
 import { decode, encode } from "./_base32_common.ts";
+import type { Uint8Array_ } from "./_types.ts";
+export type { Uint8Array_ };
 
 const lookup: string[] = "0123456789ABCDEFGHIJKLMNOPQRSTUV".split("");
 const revLookup: number[] = [];
@@ -54,7 +56,7 @@ lookup.forEach((c, i) => revLookup[c.charCodeAt(0)] = i);
  * );
  * ```
  */
-export function decodeBase32Hex(b32: string): Uint8Array {
+export function decodeBase32Hex(b32: string): Uint8Array_ {
   return decode(b32, lookup);
 }
 

diff --git a/encoding/unstable_base32hex_stream.ts b/encoding/unstable_base32hex_stream.ts
@@ -22,6 +22,8 @@
  */
 
 import { decodeBase32Hex, encodeBase32Hex } from "./unstable_base32hex.ts";
+import type { Uint8Array_ } from "./_types.ts";
+export type { Uint8Array_ };
 
 /**
  * Converts a Uint8Array stream into a base32hex-encoded stream.
@@ -90,7 +92,7 @@ export class Base32HexEncoderStream
  * ```
  */
 export class Base32HexDecoderStream
-  extends TransformStream<string, Uint8Array> {
+  extends TransformStream<string, Uint8Array_> {
   constructor() {
     let push = "";
     super({

diff --git a/encoding/unstable_base64_stream.ts b/encoding/unstable_base64_stream.ts
@@ -22,6 +22,8 @@
  */
 
 import { decodeBase64, encodeBase64 } from "./base64.ts";
+import type { Uint8Array_ } from "./_types.ts";
+export type { Uint8Array_ };
 
 /**
  * Converts a Uint8Array stream into a base64-encoded stream.
@@ -88,7 +90,7 @@ export class Base64EncoderStream extends TransformStream<Uint8Array, string> {
  * assertEquals(await toText(stream), "Hello, world!");
  * ```
  */
-export class Base64DecoderStream extends TransformStream<string, Uint8Array> {
+export class Base64DecoderStream extends TransformStream<string, Uint8Array_> {
   constructor() {
     let push = "";
     super({

diff --git a/encoding/unstable_base64url_stream.ts b/encoding/unstable_base64url_stream.ts
@@ -22,6 +22,8 @@
  */
 
 import { decodeBase64Url, encodeBase64Url } from "./base64url.ts";
+import type { Uint8Array_ } from "./_types.ts";
+export type { Uint8Array_ };
 
 /**
  * Converts a Uint8Array stream into a base64url-encoded stream.
@@ -91,7 +93,7 @@ export class Base64UrlEncoderStream
  * ```
  */
 export class Base64UrlDecoderStream
-  extends TransformStream<string, Uint8Array> {
+  extends TransformStream<string, Uint8Array_> {
   constructor() {
     let push = "";
     super({

diff --git a/encoding/unstable_hex_stream.ts b/encoding/unstable_hex_stream.ts
@@ -22,6 +22,8 @@
  */
 
 import { decodeHex, encodeHex } from "./hex.ts";
+import type { Uint8Array_ } from "./_types.ts";
+export type { Uint8Array_ };
 
 /**
  * Converts a Uint8Array stream into a hex-encoded stream.
@@ -74,7 +76,7 @@ export class HexEncoderStream extends TransformStream<Uint8Array, string> {
  * assertEquals(await toText(stream), "Hello, world!");
  * ```
  */
-export class HexDecoderStream extends TransformStream<string, Uint8Array> {
+export class HexDecoderStream extends TransformStream<string, Uint8Array_> {
   constructor() {
     let push = "";
     super({

diff --git a/encoding/varint.ts b/encoding/varint.ts
@@ -28,6 +28,9 @@
 // This implementation is a port of https://deno.land/x/varint@v2.0.0 by @keithamus
 // This module is browser compatible.
 
+import type { Uint8Array_ } from "./_types.ts";
+export type { Uint8Array_ };
+
 /**
  * The maximum value of an unsigned 64-bit integer.
  * Equivalent to `2n**64n - 1n`
@@ -216,7 +219,7 @@ export function encodeVarint(
   num: bigint | number,
   buf: Uint8Array = new Uint8Array(MaxVarintLen64),
   offset = 0,
-): [Uint8Array, number] {
+): [Uint8Array_, number] {
   num = BigInt(num);
   if (num < 0n) {
     throw new RangeError(

diff --git a/http/file_server_test.ts b/http/file_server_test.ts
@@ -1125,7 +1125,7 @@ async function readUntilMatch(
   match: string,
 ) {
   const reader = source.getReader();
-  let buf = new Uint8Array(0);
+  let buf: Uint8Array = new Uint8Array(0);
   const dec = new TextDecoder();
   while (!dec.decode(buf).includes(match)) {
     const { value } = await reader.read();