Skip to content

Commit c25b945

Browse files
committed
Fix incorrect @throws {string} JSDoc tags
Since 3b94249, we no longer throw strings.
1 parent 447adbf commit c25b945

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

KaitaiStream.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -633,7 +633,7 @@ class KaitaiStream {
633633
* @param consume True if the terminator should be consumed from the input stream.
634634
* @param eosError True to throw an error if the end of stream is reached.
635635
* @returns The read bytes.
636-
* @throws {string}
636+
* @throws {Error}
637637
*/
638638
public readBytesTerm(terminator: number, include: boolean, consume: boolean, eosError: boolean): Uint8Array {
639639
this.alignToByte();
@@ -670,7 +670,7 @@ class KaitaiStream {
670670
* @param consume True if the terminator should be consumed from the input stream.
671671
* @param eosError True to throw an error if the end of stream is reached.
672672
* @returns The read bytes.
673-
* @throws {string}
673+
* @throws {Error}
674674
*/
675675
public readBytesTermMulti(terminator: Uint8Array, include: boolean, consume: boolean, eosError: boolean): Uint8Array {
676676
this.alignToByte();
@@ -851,7 +851,7 @@ class KaitaiStream {
851851
* @param amount The shift amount in bits.
852852
* @param groupSize The number of bytes in each group.
853853
* @returns The rotated bytes.
854-
* @throws {string}
854+
* @throws {RangeError}
855855
*/
856856
public static processRotateLeft(data: Uint8Array, amount: number, groupSize: number): Uint8Array {
857857
if (groupSize !== 1)
@@ -904,7 +904,7 @@ class KaitaiStream {
904904
* @param a The dividend.
905905
* @param b The divisor.
906906
* @returns The result of `a` mod `b`.
907-
* @throws {string}
907+
* @throws {RangeError}
908908
*/
909909
public static mod(a: number, b: number): number {
910910
if (b <= 0)

0 commit comments

Comments
 (0)