[breaking] does not export DataViewIndexOutOfBoundsError (actually RangeError)

Author: gfx

src/Decoder.ts

@@ -23,9 +23,9 @@ export type DecoderOptions<ContextType = undefined> = Readonly<
     /**
      * By default, string values will be decoded as UTF-8 strings. However, if this option is true,
      * string values will be returned as Uint8Arrays without additional decoding.
-     * 
+     *
      * This is useful if the strings may contain invalid UTF-8 sequences.
-     * 
+     *
      * Note that this option only applies to string values, not map keys. Additionally, when
      * enabled, raw string length is limited by the maxBinLength option.
      */
@@ -196,9 +196,8 @@ try {
     );
   }
 }
-export const DataViewIndexOutOfBoundsError = RangeError;
 
-const MORE_DATA = new DataViewIndexOutOfBoundsError("Insufficient data");
+const MORE_DATA = new RangeError("Insufficient data");
 
 const sharedCachedKeyDecoder = new CachedKeyDecoder();
 
@@ -312,7 +311,7 @@ export class Decoder<ContextType = undefined> {
         object = this.doDecodeSync();
         decoded = true;
       } catch (e) {
-        if (!(e instanceof DataViewIndexOutOfBoundsError)) {
+        if (!(e instanceof RangeError)) {
           throw e; // rethrow
         }
         // fallthrough
@@ -368,7 +367,7 @@ export class Decoder<ContextType = undefined> {
           }
         }
       } catch (e) {
-        if (!(e instanceof DataViewIndexOutOfBoundsError)) {
+        if (!(e instanceof RangeError)) {
           throw e; // rethrow
         }
         // fallthrough
@@ -657,6 +656,9 @@ export class Decoder<ContextType = undefined> {
     return this.decodeBinary(byteLength, headerOffset);
   }
 
+  /**
+   * @throws {@link RangeError}
+   */
   private decodeUtf8String(byteLength: number, headerOffset: number): string {
     if (byteLength > this.maxStrLength) {
       throw new DecodeError(
@@ -687,6 +689,9 @@ export class Decoder<ContextType = undefined> {
     return false;
   }
 
+  /**
+   * @throws {@link RangeError}
+   */
   private decodeBinary(byteLength: number, headOffset: number): Uint8Array {
     if (byteLength > this.maxBinLength) {
       throw new DecodeError(`Max length exceeded: bin length (${byteLength}) > maxBinLength (${this.maxBinLength})`);

src/index.ts

@@ -9,8 +9,8 @@ export { decode, decodeMulti };
 import { decodeAsync, decodeArrayStream, decodeMultiStream } from "./decodeAsync";
 export { decodeAsync, decodeArrayStream, decodeMultiStream };
 
-import { Decoder, DataViewIndexOutOfBoundsError } from "./Decoder";
-export { Decoder, DataViewIndexOutOfBoundsError };
+import { Decoder } from "./Decoder";
+export { Decoder };
 import type { DecoderOptions } from "./Decoder";
 export type { DecoderOptions };
 import { DecodeError } from "./DecodeError";

test/edge-cases.test.ts

@@ -2,7 +2,6 @@
 // any errors should not break Encoder/Decoder instance states
 import assert from "assert";
 import { encode, decodeAsync, decode, Encoder, Decoder, decodeMulti, decodeMultiStream } from "../src/index";
-import { DataViewIndexOutOfBoundsError } from "../src/Decoder";
 
 function testEncoder(encoder: Encoder): void {
   const object = {
@@ -91,8 +90,7 @@ describe("edge cases", () => {
           0x92, // fixarray size=2
           0xc0, // nil
         ]);
-        // [IE11] A raw error thrown by DataView
-      }, DataViewIndexOutOfBoundsError);
+      }, RangeError);
       testDecoder(decoder);
     });