yetangitu/bitjs
1
0
Fork 0
mirror of https://github.com/codedread/bitjs synced 2025-10-05 18:34:17 +02:00
Code Issues Releases Wiki Activity

Update to @returns in all jsdoc

Browse source
This commit is contained in:
Jeff Schiller 2022-04-27 13:31:18 -07:00
parent bab0864bf8
commit 84514d1617
11 changed files with 57 additions and 57 deletions
Download patch file Download diff file Expand all files Collapse all files

18
io/bytestream.js
View file

@ -95,7 +95,7 @@ export const ByteStream =
* Peeks at the next n bytes as an unsigned number but does not advance the
* pointer.
* @param {number} n The number of bytes to peek at. Must be a positive integer.
* @return {number} The n bytes interpreted as an unsigned number.
* @returns {number} The n bytes interpreted as an unsigned number.
*/
peekNumber(n) {
const num = parseInt(n, 10);
@ -136,7 +136,7 @@ export const ByteStream =
* Returns the next n bytes as an unsigned number (or -1 on error)
* and advances the stream pointer n bytes.
* @param {number} n The number of bytes to read. Must be a positive integer.
* @return {number} The n bytes interpreted as an unsigned number.
* @returns {number} The n bytes interpreted as an unsigned number.
*/
readNumber(n) {
const num = this.peekNumber(n);
@ -149,7 +149,7 @@ export const ByteStream =
* Returns the next n bytes as a signed number but does not advance the
* pointer.
* @param {number} n The number of bytes to read. Must be a positive integer.
* @return {number} The bytes interpreted as a signed number.
* @returns {number} The bytes interpreted as a signed number.
*/
peekSignedNumber(n) {
let num = this.peekNumber(n);
@ -165,7 +165,7 @@ export const ByteStream =
/**
* Returns the next n bytes as a signed number and advances the stream pointer.
* @param {number} n The number of bytes to read. Must be a positive integer.
* @return {number} The bytes interpreted as a signed number.
* @returns {number} The bytes interpreted as a signed number.
*/
readSignedNumber(n) {
const num = this.peekSignedNumber(n);
@ -179,7 +179,7 @@ export const ByteStream =
* is true.
* @param {number} n The number of bytes to read. Must be a positive integer.
* @param {boolean} movePointers Whether to move the pointers.
* @return {Uint8Array} The subarray.
* @returns {Uint8Array} The subarray.
*/
peekBytes(n, movePointers) {
const num = parseInt(n, 10);
@ -225,7 +225,7 @@ export const ByteStream =
/**
* Reads the next n bytes as a sub-array.
* @param {number} n The number of bytes to read. Must be a positive integer.
* @return {Uint8Array} The subarray.
* @returns {Uint8Array} The subarray.
*/
readBytes(n) {
return this.peekBytes(n, true);
@ -234,7 +234,7 @@ export const ByteStream =
/**
* Peeks at the next n bytes as an ASCII string but does not advance the pointer.
* @param {number} n The number of bytes to peek at. Must be a positive integer.
* @return {string} The next n bytes as a string.
* @returns {string} The next n bytes as a string.
*/
peekString(n) {
const num = parseInt(n, 10);
@ -269,7 +269,7 @@ export const ByteStream =
* Returns the next n bytes as an ASCII string and advances the stream pointer
* n bytes.
* @param {number} n The number of bytes to read. Must be a positive integer.
* @return {string} The next n bytes as a string.
* @returns {string} The next n bytes as a string.
*/
readString(n) {
const strToReturn = this.peekString(n);
@ -294,7 +294,7 @@ export const ByteStream =
/**
* Creates a new ByteStream from this ByteStream that can be read / peeked.
* @return {ByteStream} A clone of this ByteStream.
* @returns {ByteStream} A clone of this ByteStream.
*/
tee() {
const clone = new ByteStream(this.bytes.buffer);