JSPrismarine

API reference / @jsprismarine/protocol / NetworkBinaryStream

Class: NetworkBinaryStream ​

Defined in: protocol/src/NetworkBinaryStream.ts:7

Represents an extended version of the BinaryStream class that includes minecraft-specific serialization methods.

Extends ​

Constructors ​

Constructor ​

new NetworkBinaryStream(buffer?, offset?, initialCapacity?): NetworkBinaryStream

Defined in: binaryutils/src/BinaryStream.ts:49

Creates a new BinaryStream instance.

Parameters ​

buffer? ​

Buffer<ArrayBufferLike>

The array or Buffer containing binary data.

offset? ​

number = 0

The initial pointer position.

initialCapacity? ​

number = 0

Pre-allocates the write buffer to this size. Use it when the encoded size is known up front: it skips the 256 -> 512 -> 1024 ... growth ladder, and with resetWrite it lets a long-lived encoder run without allocating at all.

Returns ​

NetworkBinaryStream

Inherited from ​

BinaryStream.constructor

Methods ​

clear() ​

clear(): void

Defined in: binaryutils/src/BinaryStream.ts:977

Clears the whole BinaryStream instance.

The write buffer and its capacity are kept, so any view previously returned by getWriteBuffer is invalidated. See resetWrite.

Returns ​

void

Inherited from ​

BinaryStream.clear

copyInto() ​

copyInto(target, offset?): number

Defined in: binaryutils/src/BinaryStream.ts:856

Copies the encoded bytes into a caller-owned buffer at offset and returns the offset just past them. Lets many packets be encoded into one arena with no per-packet allocation at all.

Parameters ​

target ​

Buffer

offset? ​

number = 0

Returns ​

number

the new offset

Inherited from ​

BinaryStream.copyInto

copyOut() ​

copyOut(): Buffer

Defined in: binaryutils/src/BinaryStream.ts:840

Returns the encoded bytes as an exactly-sized, standalone Buffer.

Unlike getWriteBuffer the result does not alias this stream, so it survives resetWrite, and it does not pin a pool chunk: because Buffer.allocUnsafe is pool-backed (Buffer.poolSize is 64 KB on current Node), holding on to a handful of small slices from getWriteBuffer can keep megabytes alive.

Returns ​

Buffer

Inherited from ​

BinaryStream.copyOut

feof() ​

feof(): boolean

Defined in: binaryutils/src/BinaryStream.ts:875

Returns whatever or not the read offset is at end of line.

Returns ​

boolean

Inherited from ​

BinaryStream.feof

getBuffer() ​

getBuffer(): Buffer

Defined in: binaryutils/src/BinaryStream.ts:912

Returns the encoded buffer.

Beware: when a read buffer is present this returns that, discarding everything written. On a stream used for both reading and writing it never returns your output.

Returns ​

Buffer

Deprecated ​

See getReadBuffer and getWriteBuffer.

Inherited from ​

BinaryStream.getBuffer

getReadBuffer() ​

getReadBuffer(): Buffer<ArrayBufferLike> | null

Defined in: binaryutils/src/BinaryStream.ts:920

Returns the read buffer if available.

Returns ​

Buffer<ArrayBufferLike> | null

Inherited from ​

BinaryStream.getReadBuffer

getReadIndex() ​

getReadIndex(): number

Defined in: binaryutils/src/BinaryStream.ts:1019

Retuns the read index.

Returns ​

number

Inherited from ​

BinaryStream.getReadIndex

getWriteBuffer() ​

getWriteBuffer(): Buffer

Defined in: binaryutils/src/BinaryStream.ts:936

Returns the encoded bytes as a view over this stream's internal buffer.

The view is only valid until the next write: resetWrite, clear and reuse all rewind the cursor without reallocating, so a previously returned buffer is silently overwritten by the next packet. If you queue the result - a send queue, a resend window - use copyOut or copyInto instead.

It also keeps the whole pooled 64 KB chunk it was carved from alive; retaining a scattered handful of small packets this way can pin megabytes.

Returns ​

Buffer

Inherited from ​

BinaryStream.getWriteBuffer

getWriteIndex() ​

getWriteIndex(): number

Defined in: binaryutils/src/BinaryStream.ts:1027

Returns the write index.

Returns ​

number

Inherited from ​

BinaryStream.getWriteIndex

read() ​

read(len): Buffer

Defined in: binaryutils/src/BinaryStream.ts:62

Reads a slice of buffer by the given length.

Parameters ​

len ​

number

How many bytes to read: a nonnegative integer.

Returns ​

Buffer

Throws ​

AssertionError when len is negative or not an integer, or runs past the end.

Inherited from ​

BinaryStream.read

readBoolean() ​

readBoolean(): boolean

Defined in: binaryutils/src/BinaryStream.ts:179

Reads a boolean (true or false).

Returns ​

boolean

Inherited from ​

BinaryStream.readBoolean

readByte() ​

readByte(): number

Defined in: binaryutils/src/BinaryStream.ts:143

Reads an unsigned byte (0 to 255).

Returns ​

number

Inherited from ​

BinaryStream.readByte

readDouble() ​

readDouble(): number

Defined in: binaryutils/src/BinaryStream.ts:481

Returns a 64 bit (8 bytes) big-endian flating point number.

Returns ​

number

Inherited from ​

BinaryStream.readDouble

readDoubleLE() ​

readDoubleLE(): number

Defined in: binaryutils/src/BinaryStream.ts:501

Returns a 64 bit (8 bytes) little-endian flating point number.

Returns ​

number

Inherited from ​

BinaryStream.readDoubleLE

readFloat() ​

readFloat(): number

Defined in: binaryutils/src/BinaryStream.ts:441

Returns a 32 bit (4 bytes) big-endian flating point number.

Returns ​

number

Inherited from ​

BinaryStream.readFloat

readFloatLE() ​

readFloatLE(): number

Defined in: binaryutils/src/BinaryStream.ts:461

Returns a 32 bit (4 bytes) big-endian flating point number.

Returns ​

number

Inherited from ​

BinaryStream.readFloatLE

readInt() ​

readInt(): number

Defined in: binaryutils/src/BinaryStream.ts:361

Reads a 32 bit (4 bytes) big-endian signed number.

Returns ​

number

Inherited from ​

BinaryStream.readInt

readIntLE() ​

readIntLE(): number

Defined in: binaryutils/src/BinaryStream.ts:381

Reads a 32 bit (4 bytes) signed number.

Returns ​

number

Inherited from ​

BinaryStream.readIntLE

readLELengthASCIIString() ​

readLELengthASCIIString(): string

Defined in: protocol/src/NetworkBinaryStream.ts:31

Reads an ASCII string with a little-endian uint32 byte length, the form the LoginPacket connection request uses for its JWT chain and client data. The docs describe only the varuint32-prefixed string primitive, not this one.

Returns ​

string

The read string.

readLengthPrefixed() ​

readLengthPrefixed(): Buffer

Defined in: binaryutils/src/BinaryStream.ts:107

Reads a varuint32 byte length, then that many bytes.

Returns ​

Buffer

The bytes, a view into the stream's buffer.

Inherited from ​

BinaryStream.readLengthPrefixed

readLong() ​

readLong(): bigint

Defined in: binaryutils/src/BinaryStream.ts:521

Returns a 64 bit (8 bytes) signed big-endian number.

Returns ​

bigint

Inherited from ​

BinaryStream.readLong

readLongLE() ​

readLongLE(): bigint

Defined in: binaryutils/src/BinaryStream.ts:540

Returns a 64 bit (8 bytes) signed little-endian number.

Returns ​

bigint

Inherited from ​

BinaryStream.readLongLE

readOptional() ​

readOptional<T>(read): T | undefined

Defined in: protocol/src/NetworkBinaryStream.ts:51

Reads a value Cereal bound as brstd::optional<T>: a presence boolean, then the value when the boolean is 1.

Type Parameters ​

T ​

T

Parameters ​

read ​

() => T

Reads the value once the presence byte says it is there.

Returns ​

T | undefined

The value, or undefined when the presence byte is 0.

readRemaining() ​

readRemaining(): Buffer

Defined in: binaryutils/src/BinaryStream.ts:888

Reads the remaining bytes and returns the buffer slice.

Returns ​

Buffer

Inherited from ​

BinaryStream.readRemaining

readShort() ​

readShort(): number

Defined in: binaryutils/src/BinaryStream.ts:197

Reads a 16 bit (2 bytes) signed big-endian number.

Returns ​

number

Inherited from ​

BinaryStream.readShort

readShortLE() ​

readShortLE(): number

Defined in: binaryutils/src/BinaryStream.ts:217

Reads a 16 bit (2 bytes) signed little-endian number.

Returns ​

number

Inherited from ​

BinaryStream.readShortLE

readSignedByte() ​

readSignedByte(): number

Defined in: binaryutils/src/BinaryStream.ts:161

Reads a signed byte (-128 to 127).

Returns ​

number

Inherited from ​

BinaryStream.readSignedByte

readString() ​

readString(): string

Defined in: protocol/src/NetworkBinaryStream.ts:13

Reads a string from the stream: a varuint32 byte length, then UTF-8 bytes. The docs' string primitive

Returns ​

string

The read string.

readTriad() ​

readTriad(): number

Defined in: binaryutils/src/BinaryStream.ts:277

Reads a 24 bit (3 bytes) signed big-endian number.

Returns ​

number

Inherited from ​

BinaryStream.readTriad

readTriadLE() ​

readTriadLE(): number

Defined in: binaryutils/src/BinaryStream.ts:298

Reads a 24 bit (3 bytes) little-endian number.

Returns ​

number

Inherited from ​

BinaryStream.readTriadLE

readUnsignedInt() ​

readUnsignedInt(): number

Defined in: binaryutils/src/BinaryStream.ts:401

Reads a 32 bit (4 bytes) big-endian unsigned number.

Returns ​

number

Inherited from ​

BinaryStream.readUnsignedInt

readUnsignedIntLE() ​

readUnsignedIntLE(): number

Defined in: binaryutils/src/BinaryStream.ts:421

Reads a 32 bit (4 bytes) little-endian unsigned number.

Returns ​

number

Inherited from ​

BinaryStream.readUnsignedIntLE

readUnsignedLong() ​

readUnsignedLong(): bigint

Defined in: binaryutils/src/BinaryStream.ts:559

Returns a 64 bit (8 bytes) unsigned big-endian number.

Returns ​

bigint

Inherited from ​

BinaryStream.readUnsignedLong

readUnsignedLongLE() ​

readUnsignedLongLE(): bigint

Defined in: binaryutils/src/BinaryStream.ts:578

Returns a 64 bit (8 bytes) unsigned little-endian number.

Returns ​

bigint

Inherited from ​

BinaryStream.readUnsignedLongLE

readUnsignedShort() ​

readUnsignedShort(): number

Defined in: binaryutils/src/BinaryStream.ts:237

Reads a 16 bit (2 bytes) unsigned big-endian number.

Returns ​

number

Inherited from ​

BinaryStream.readUnsignedShort

readUnsignedShortLE() ​

readUnsignedShortLE(): number

Defined in: binaryutils/src/BinaryStream.ts:257

Reads a 16 bit (2 bytes) unsigned little-endian number.

Returns ​

number

Inherited from ​

BinaryStream.readUnsignedShortLE

readUnsignedTriad() ​

readUnsignedTriad(): number

Defined in: binaryutils/src/BinaryStream.ts:319

Reads a 24 bit (3 bytes) unsigned big-endian number.

Returns ​

number

Inherited from ​

BinaryStream.readUnsignedTriad

readUnsignedTriadLE() ​

readUnsignedTriadLE(): number

Defined in: binaryutils/src/BinaryStream.ts:340

Reads a 24 bit (3 bytes) unsigned little-endian number.

Returns ​

number

Inherited from ​

BinaryStream.readUnsignedTriadLE

readUnsignedVarInt() ​

readUnsignedVarInt(): number

Defined in: binaryutils/src/BinaryStream.ts:619

Reads a 32 bit unsigned number.

Returns ​

number

Inherited from ​

BinaryStream.readUnsignedVarInt

readUnsignedVarLong() ​

readUnsignedVarLong(): bigint

Defined in: binaryutils/src/BinaryStream.ts:702

Reads a 64 bit unsigned variable-length number.

Returns ​

bigint

Inherited from ​

BinaryStream.readUnsignedVarLong

readVarInt() ​

readVarInt(): number

Defined in: binaryutils/src/BinaryStream.ts:597

Reads a 32 bit (4 bytes) zigzag-encoded number.

Returns ​

number

Inherited from ​

BinaryStream.readVarInt

readVarLong() ​

readVarLong(): bigint

Defined in: binaryutils/src/BinaryStream.ts:675

Reads a 64 bit zigzag-encoded variable-length number.

Returns ​

bigint

Inherited from ​

BinaryStream.readVarLong

readVarString() ​

readVarString(): string

Defined in: binaryutils/src/BinaryStream.ts:126

Reads a string: a varuint32 byte length, then UTF-8 bytes, the form Bedrock writes strings in. Named apart from readString because RakNet's packets read theirs with a u16 length. The docs' string primitive

Returns ​

string

The read string.

Inherited from ​

BinaryStream.readVarString

reserve() ​

reserve(capacity): this

Defined in: binaryutils/src/BinaryStream.ts:805

Grows the write buffer so that at least capacity bytes can be written without any further allocation, and returns this stream.

Pre-sizing skips the 256 -> 512 -> 1024 ... growth ladder, each step of which copies the whole payload; a 3 KB packet starting from the 256-byte floor performs five allocations and memcpy's 1.25x its own size before it is done.

Parameters ​

capacity ​

number

Returns ​

this

Inherited from ​

BinaryStream.reserve

resetWrite() ​

resetWrite(): void

Defined in: binaryutils/src/BinaryStream.ts:827

Rewinds the write cursor while keeping the allocated capacity, so a long-lived encoder reaches a steady state where it never allocates again. This is the intended way to reuse a stream for many packets.

Note the aliasing contract, which it shares with clear and reuse: any buffer previously handed out by getWriteBuffer is a view over this stream's memory and is invalidated by this call. Use copyOut or copyInto for output you intend to keep.

Returns ​

void

Inherited from ​

BinaryStream.resetWrite

reuse() ​

reuse(buf): void

Defined in: binaryutils/src/BinaryStream.ts:991

Conventional method to reuse the stream without having to create a new BinaryStream instance.

The write buffer and its capacity are kept, so any view previously returned by getWriteBuffer is invalidated. See resetWrite.

Parameters ​

buf ​

Buffer

The new buffer instance.

Returns ​

void

Inherited from ​

BinaryStream.reuse

setBuffer() ​

setBuffer(buf): void

Defined in: binaryutils/src/BinaryStream.ts:946

Sets the buffer for reading. make sure to reset the reading index!

Parameters ​

buf ​

Buffer

The new Buffer.

Returns ​

void

Deprecated ​

See setReadBuffer and setWriteBuffer.

Inherited from ​

BinaryStream.setBuffer

setReadBuffer() ​

setReadBuffer(buf, rIndex?): void

Defined in: binaryutils/src/BinaryStream.ts:955

Sets the buffer for reading.

Parameters ​

buf ​

Buffer

The new Buffer.

rIndex? ​

number = 0

The new read index (default: 0, pass -1 to keep current).

Returns ​

void

Inherited from ​

BinaryStream.setReadBuffer

setReadIndex() ​

setReadIndex(index): void

Defined in: binaryutils/src/BinaryStream.ts:1001

Sets the reading index.

Parameters ​

index ​

number

The new read index.

Returns ​

void

Inherited from ​

BinaryStream.setReadIndex

setWriteBuffer() ​

setWriteBuffer(buf, wIndex?): void

Defined in: binaryutils/src/BinaryStream.ts:965

Sets the buffer for writing.

Parameters ​

buf ​

Buffer

The new Buffer.

wIndex? ​

number = 0

The new write index (default: 0, pass -1 to keep current).

Returns ​

void

Inherited from ​

BinaryStream.setWriteBuffer

setWriteIndex() ​

setWriteIndex(index): void

Defined in: binaryutils/src/BinaryStream.ts:1010

Sets the new writing index.

Parameters ​

index ​

number

The new write index.

Returns ​

void

Inherited from ​

BinaryStream.setWriteIndex

skip() ​

skip(len): void

Defined in: binaryutils/src/BinaryStream.ts:899

Skips len bytes on the buffer.

Parameters ​

len ​

number

Returns ​

void

Inherited from ​

BinaryStream.skip

write() ​

write(buf): void

Defined in: binaryutils/src/BinaryStream.ts:76

Appends a buffer to the main buffer.

Parameters ​

buf ​

Uint8Array

Returns ​

void

Inherited from ​

BinaryStream.write

writeBoolean() ​

writeBoolean(v): void

Defined in: binaryutils/src/BinaryStream.ts:188

Writes a boolean (true or false).

Parameters ​

v ​

boolean

Returns ​

void

Inherited from ​

BinaryStream.writeBoolean

writeByte() ​

writeByte(v): void

Defined in: binaryutils/src/BinaryStream.ts:152

Writes an unsigned byte (0 to 255).

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

BinaryStream.writeByte

writeDouble() ​

writeDouble(v): void

Defined in: binaryutils/src/BinaryStream.ts:490

Writes a 64 bit (8 bytes) big-endian floating point number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

BinaryStream.writeDouble

writeDoubleLE() ​

writeDoubleLE(v): void

Defined in: binaryutils/src/BinaryStream.ts:510

Writes a 64 bit (8 bytes) little-endian floating point number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

BinaryStream.writeDoubleLE

writeFloat() ​

writeFloat(v): void

Defined in: binaryutils/src/BinaryStream.ts:450

Writes a 32 bit (4 bytes) big-endian floating point number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

BinaryStream.writeFloat

writeFloatLE() ​

writeFloatLE(v): void

Defined in: binaryutils/src/BinaryStream.ts:470

Writes a 32 bit (4 bytes) little-endian floating point number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

BinaryStream.writeFloatLE

writeInt() ​

writeInt(v): void

Defined in: binaryutils/src/BinaryStream.ts:370

Writes a 32 bit (4 bytes) big-endian signed number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

BinaryStream.writeInt

writeIntLE() ​

writeIntLE(v): void

Defined in: binaryutils/src/BinaryStream.ts:390

Writes a 32 bit (4 bytes) little-endian signed number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

BinaryStream.writeIntLE

writeLELengthASCIIString() ​

writeLELengthASCIIString(str): void

Defined in: protocol/src/NetworkBinaryStream.ts:39

Writes a length-prefixed ASCII string to the stream.

Parameters ​

str ​

string

The string to write.

Returns ​

void

writeLengthPrefixed() ​

writeLengthPrefixed(buf): void

Defined in: binaryutils/src/BinaryStream.ts:115

Writes a varuint32 byte length, then the bytes.

Parameters ​

buf ​

Uint8Array

The bytes to append.

Returns ​

void

Inherited from ​

BinaryStream.writeLengthPrefixed

writeLong() ​

writeLong(v): void

Defined in: binaryutils/src/BinaryStream.ts:530

Writes a 64 bit (8 bytes) signed big-endian number.

Parameters ​

v ​

bigint

Returns ​

void

Inherited from ​

BinaryStream.writeLong

writeLongLE() ​

writeLongLE(v): void

Defined in: binaryutils/src/BinaryStream.ts:549

Writes a 64 bit (8 bytes) signed little-endian number.

Parameters ​

v ​

bigint

Returns ​

void

Inherited from ​

BinaryStream.writeLongLE

writeOptional() ​

writeOptional<T>(value, write): void

Defined in: protocol/src/NetworkBinaryStream.ts:61

Writes a value Cereal bound as brstd::optional<T>: a presence boolean, then the value when it is defined.

Type Parameters ​

T ​

T

Parameters ​

value ​

T | undefined

The value, or undefined to write a single 0 byte.

write ​

(value) => void

Writes the value after the presence byte.

Returns ​

void

writeShort() ​

writeShort(v): void

Defined in: binaryutils/src/BinaryStream.ts:206

Writes a 16 bit (2 bytes) signed big-endian number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

BinaryStream.writeShort

writeShortLE() ​

writeShortLE(v): void

Defined in: binaryutils/src/BinaryStream.ts:226

Writes a 16 bit (2 bytes) signed little-endian number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

BinaryStream.writeShortLE

writeSignedByte() ​

writeSignedByte(v): void

Defined in: binaryutils/src/BinaryStream.ts:170

Writes a signed byte (-128 to 127).

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

BinaryStream.writeSignedByte

writeString() ​

writeString(str): void

Defined in: protocol/src/NetworkBinaryStream.ts:21

Writes a string to the stream.

Parameters ​

str ​

string

The string to write.

Returns ​

void

writeTriad() ​

writeTriad(v): void

Defined in: binaryutils/src/BinaryStream.ts:286

Writes a 24 bit (3 bytes) signed big-endian number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

BinaryStream.writeTriad

writeTriadLE() ​

writeTriadLE(v): void

Defined in: binaryutils/src/BinaryStream.ts:307

Writes a 24 bit (3 bytes) signed little-endian number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

BinaryStream.writeTriadLE

writeUnsignedInt() ​

writeUnsignedInt(v): void

Defined in: binaryutils/src/BinaryStream.ts:410

Writes a 32 bit (4 bytes) big-endian unsigned number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

BinaryStream.writeUnsignedInt

writeUnsignedIntLE() ​

writeUnsignedIntLE(v): void

Defined in: binaryutils/src/BinaryStream.ts:430

Writes a 32 bit (4 bytes) little-endian unsigned number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

BinaryStream.writeUnsignedIntLE

writeUnsignedLong() ​

writeUnsignedLong(v): void

Defined in: binaryutils/src/BinaryStream.ts:568

Writes a 64 bit (8 bytes) unsigned big-endian number.

Parameters ​

v ​

bigint

Returns ​

void

Inherited from ​

BinaryStream.writeUnsignedLong

writeUnsignedLongLE() ​

writeUnsignedLongLE(v): void

Defined in: binaryutils/src/BinaryStream.ts:587

Writes a 64 bit (8 bytes) unsigned little-endian number.

Parameters ​

v ​

bigint

Returns ​

void

Inherited from ​

BinaryStream.writeUnsignedLongLE

writeUnsignedShort() ​

writeUnsignedShort(v): void

Defined in: binaryutils/src/BinaryStream.ts:246

Writes a 16 bit (2 bytes) unsigned big-endian number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

BinaryStream.writeUnsignedShort

writeUnsignedShortLE() ​

writeUnsignedShortLE(v): void

Defined in: binaryutils/src/BinaryStream.ts:266

Writes a 16 bit (2 bytes) unsigned little-endian number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

BinaryStream.writeUnsignedShortLE

writeUnsignedTriad() ​

writeUnsignedTriad(v): void

Defined in: binaryutils/src/BinaryStream.ts:328

Writes a 24 bit (3 bytes) unsigned big-endian number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

BinaryStream.writeUnsignedTriad

writeUnsignedTriadLE() ​

writeUnsignedTriadLE(v): void

Defined in: binaryutils/src/BinaryStream.ts:349

Writes a 24 bit (3 bytes) unsigned little-endian number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

BinaryStream.writeUnsignedTriadLE

writeUnsignedVarInt() ​

writeUnsignedVarInt(v): void

Defined in: binaryutils/src/BinaryStream.ts:657

Writes a 32 bit unsigned number with variable-length.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

BinaryStream.writeUnsignedVarInt

writeUnsignedVarLong() ​

writeUnsignedVarLong(v): void

Defined in: binaryutils/src/BinaryStream.ts:742

Writes a 64 bit unsigned variable-length number.

Parameters ​

v ​

bigint

Returns ​

void

Inherited from ​

BinaryStream.writeUnsignedVarLong

writeUTF8String() ​

writeUTF8String(value): void

Defined in: binaryutils/src/BinaryStream.ts:91

Writes a UTF-8 string directly into the stream's backing buffer.

Parameters ​

value ​

string

The string to encode.

Returns ​

void

Inherited from ​

BinaryStream.writeUTF8String

writeVarInt() ​

writeVarInt(v): void

Defined in: binaryutils/src/BinaryStream.ts:609

Writes a 32 bit (4 bytes) zigzag-encoded number.

Parameters ​

v ​

number

Returns ​

void

Inherited from ​

BinaryStream.writeVarInt

writeVarLong() ​

writeVarLong(v): void

Defined in: binaryutils/src/BinaryStream.ts:688

Writes a 64 bit unsigned zigzag-encoded number.

Parameters ​

v ​

bigint

Returns ​

void

Inherited from ​

BinaryStream.writeVarLong

writeVarString() ​

writeVarString(str): void

Defined in: binaryutils/src/BinaryStream.ts:134

Writes a string as a varuint32 byte length, then UTF-8 bytes.

Parameters ​

str ​

string

The string to write.

Returns ​

void

Inherited from ​

BinaryStream.writeVarString