Skip to content

Commit 435b604

Browse files
committed
Updated JS Docs
1 parent 3e1e270 commit 435b604

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

src/BinaryReader.ts

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,19 @@ import { Endianness } from "./Endianness";
1414
* Any time the word _stream_ is used in the documentation it refers to the `ArrayBuffer` provided in the constructor of this class.
1515
*/
1616
export class BinaryReader {
17+
/**
18+
* The actual stream used for reading. Keep in mind it can be larger than the view.
19+
*/
1720
private _stream: ArrayBuffer;
21+
22+
/**
23+
* A view into the buffer.
24+
*/
1825
private _view: Uint8Array;
1926

27+
/**
28+
* Current reading position in the stream.
29+
*/
2030
private _position: number;
2131

2232
/**
@@ -65,7 +75,7 @@ export class BinaryReader {
6575
}
6676

6777
/**
68-
* @ignore
78+
* Number of bytes remaining to be read.
6979
*/
7080
public get remainingBytes(): number {
7181
return this.length - this.position;

0 commit comments

Comments
 (0)