BinaryWriter
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new BinaryWriter(
encodeUtf8?):BinaryWriter
Parameters
Section titled “Parameters”encodeUtf8?
Section titled “encodeUtf8?”(text) => Uint8Array
Returns
Section titled “Returns”BinaryWriter
Methods
Section titled “Methods”bool()
Section titled “bool()”bool(
value):this
Write a bool value, a variant.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”this
bytes()
Section titled “bytes()”bytes(
value):this
Write a bytes value, length-delimited arbitrary data.
Parameters
Section titled “Parameters”Uint8Array
Returns
Section titled “Returns”this
double()
Section titled “double()”double(
value):this
Write a double value, a 64-bit floating point number.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
finish()
Section titled “finish()”finish():
Uint8Array
Return all bytes written and reset this writer.
Returns
Section titled “Returns”Uint8Array
fixed32()
Section titled “fixed32()”fixed32(
value):this
Write a fixed32 value, an unsigned, fixed-length 32-bit integer.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
fixed64()
Section titled “fixed64()”fixed64(
value):this
Write a fixed64 value, an unsigned, fixed-length 64 bit integer.
Parameters
Section titled “Parameters”string | number | bigint
Returns
Section titled “Returns”this
float()
Section titled “float()”float(
value):this
Write a float value, 32-bit floating point number.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
fork()
Section titled “fork()”fork():
this
Start a new fork for length-delimited data like a message or a packed repeated field.
Must be joined later with join().
Returns
Section titled “Returns”this
int32()
Section titled “int32()”int32(
value):this
Write a int32 value, a signed 32 bit varint.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
int64()
Section titled “int64()”int64(
value):this
Write a int64 value, a signed 64-bit varint.
Parameters
Section titled “Parameters”string | number | bigint
Returns
Section titled “Returns”this
join()
Section titled “join()”join():
this
Join the last fork. Write its length and bytes, then return to the previous state.
Returns
Section titled “Returns”this
raw(
chunk):this
Write a chunk of raw bytes.
Parameters
Section titled “Parameters”Uint8Array
Returns
Section titled “Returns”this
sfixed32()
Section titled “sfixed32()”sfixed32(
value):this
Write a sfixed32 value, a signed, fixed-length 32-bit integer.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
sfixed64()
Section titled “sfixed64()”sfixed64(
value):this
Write a fixed64 value, a signed, fixed-length 64-bit integer.
Parameters
Section titled “Parameters”string | number | bigint
Returns
Section titled “Returns”this
sint32()
Section titled “sint32()”sint32(
value):this
Write a sint32 value, a signed, zigzag-encoded 32-bit varint.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
sint64()
Section titled “sint64()”sint64(
value):this
Write a sint64 value, a signed, zig-zag-encoded 64-bit varint.
Parameters
Section titled “Parameters”string | number | bigint
Returns
Section titled “Returns”this
string()
Section titled “string()”string(
value):this
Write a string value, length-delimited data converted to UTF-8 text.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this
tag(
fieldNo,type):this
Writes a tag (field number and wire type).
Equivalent to uint32( (fieldNo << 3 | type) >>> 0 ).
Generated code should compute the tag ahead of time and call uint32().
Parameters
Section titled “Parameters”fieldNo
Section titled “fieldNo”number
Returns
Section titled “Returns”this
uint32()
Section titled “uint32()”uint32(
value):this
Write a uint32 value, an unsigned 32 bit varint.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
uint64()
Section titled “uint64()”uint64(
value):this
Write a uint64 value, an unsigned 64-bit varint.
Parameters
Section titled “Parameters”string | number | bigint
Returns
Section titled “Returns”this