protobuf.js

API documentation

Class: BufferWriter

BufferWriter

Wire format writer using node buffers.

new BufferWriter()

writer_buffer.js, line 23

Constructs a new buffer writer instance.

Extends

Members

buf { Uint8Array }

writer.js, line 29

Backing buffer.

len { number }

writer.js, line 44

Current write position.

Deprecated:
Use Writer#pos instead.

pos { number }

writer.js, line 23

Write cursor into Writer#buf.

states { Array<number> | null }

writer.js, line 41

Stack of forked length-prefix positions.

view { DataView | null }

writer.js, line 35

Cached DataView over Writer#buf.

Methods

inherited bool(value){ Writer }

writer.js, line 233

Writes a boolish value as a varint.

Parameters:
value boolean

Value to write
Returns:
Writer this

inherited bools(value){ Writer }

writer.js, line 489

Writes an array of boolish values as a packed repeated field.

Parameters:
value Array<boolean>

Values to write
Returns:
Writer this

inherited bytes(value){ Writer }

writer_buffer.js, line 51

Writes a sequence of bytes.

Parameters:
value Uint8Array | string

Buffer or base64 encoded string to write
Returns:
Writer this

inherited double(value){ Writer }

writer.js, line 309

Writes a double (64 bit float).

Parameters:
value number

Value to write
Returns:
Writer this

inherited doubles(value){ Writer }

writer.js, line 593

Writes an array of doubles (64 bit float) as a packed repeated field.

Parameters:
value Array<number>

Values to write
Returns:
Writer this

finish(){ Buffer }

writer_buffer.js, line 93

Finishes the write operation.

Returns:
Buffer Finished buffer

inherited finishInto(buf, offset){ T }

writer.js, line 689

Finishes the write operation, writing into the provided buffer.
The caller must ensure that buf has enough space starting at offset
to hold Writer#pos bytes.

Parameters:
buf T

Target buffer
offset number 0 optional

Offset to start writing at
Returns:
T The provided buffer

inherited fixed32(value){ Writer }

writer.js, line 251

Writes an unsigned 32 bit value as fixed 32 bits.

Parameters:
value number

Value to write
Returns:
Writer this

inherited fixed32s(value){ Writer }

writer.js, line 517

Writes an array of unsigned 32 bit values as packed, fixed 32 bits.

Parameters:
value Array<number>

Values to write
Returns:
Writer this

inherited fixed64(value){ Writer }

writer.js, line 272

Writes an unsigned 64 bit value as fixed 64 bits.

Parameters:
value Long | number | string

Value to write
Throws:
TypeError

If value is a string and no long library is present.
Returns:
Writer this

inherited fixed64s(value){ Writer }

writer.js, line 545

Writes an array of unsigned 64 bit values as packed, fixed 64 bits.

Parameters:
value Array<(Long|number|string)>

Values to write
Returns:
Writer this

inherited float(value){ Writer }

writer.js, line 296

Writes a float (32 bit).

Parameters:
value number

Value to write
Returns:
Writer this

inherited floats(value){ Writer }

writer.js, line 573

Writes an array of floats (32 bit) as a packed repeated field.

Parameters:
value Array<number>

Values to write
Returns:
Writer this

inherited fork(){ Writer }

writer.js, line 612

Forks this writer's state by pushing it to a stack.

Returns:
Writer this

inherited int32(value){ Writer }

writer.js, line 156

Writes a signed 32 bit value as a varint.

Parameters:
value number

Value to write
Returns:
Writer this

inherited int32s(value){ Writer }

writer.js, line 418

Writes an array of signed 32 bit values as a packed repeated field.

Parameters:
value Array<number>

Values to write
Returns:
Writer this

inherited int64(value){ Writer }

writer.js, line 212

Writes a signed 64 bit value as a varint.

Parameters:
value Long | number | string

Value to write
Throws:
TypeError

If value is a string and no long library is present.
Returns:
Writer this

inherited int64s(value){ Writer }

writer.js, line 467

Writes an array of signed 64 bit values as a packed repeated field.

Parameters:
value Array<(Long|number|string)>

Values to write
Returns:
Writer this

inherited ldelim(){ Writer }

writer.js, line 637

Resets to the last state and prepends the fork state's current write length as a varint.

Returns:
Writer this

inherited raw(value){ Writer }

writer.js, line 345

Writes raw bytes without a tag or length prefix.

Parameters:
value Uint8Array

Raw bytes
Returns:
Writer this

inherited reset(){ Writer }

writer.js, line 623

Resets this instance to the last state.

Returns:
Writer this

inherited sfixed32(value){ Writer }

writer.js, line 264

Writes a signed 32 bit value as fixed 32 bits.

Parameters:
value number

Value to write
Returns:
Writer this

inherited sfixed32s(value){ Writer }

writer.js, line 538

Writes an array of signed 32 bit values as packed, fixed 32 bits.

Parameters:
value Array<number>

Values to write
Returns:
Writer this

inherited sfixed64(value){ Writer }

writer.js, line 288

Writes a signed 64 bit value as fixed 64 bits.

Parameters:
value Long | number | string

Value to write
Throws:
TypeError

If value is a string and no long library is present.
Returns:
Writer this

inherited sfixed64s(value){ Writer }

writer.js, line 566

Writes an array of signed 64 bit values as packed, fixed 64 bits.

Parameters:
value Array<(Long|number|string)>

Values to write
Returns:
Writer this

inherited sint32(value){ Writer }

writer.js, line 171

Writes a 32 bit value as a varint, zig-zag encoded.

Parameters:
value number

Value to write
Returns:
Writer this

inherited sint32s(value){ Writer }

writer.js, line 437

Writes an array of 32 bit values as packed, zig-zag encoded varints.

Parameters:
value Array<number>

Values to write
Returns:
Writer this

inherited sint64(value){ Writer }

writer.js, line 220

Writes a signed 64 bit value as a varint, zig-zag encoded.

Parameters:
value Long | number | string

Value to write
Throws:
TypeError

If value is a string and no long library is present.
Returns:
Writer this

inherited sint64s(value){ Writer }

writer.js, line 474

Writes an array of 64 bit values as packed, zig-zag encoded varints.

Parameters:
value Array<(Long|number|string)>

Values to write
Returns:
Writer this

inherited string(value){ Writer }

writer_buffer.js, line 67

Writes a string.

Parameters:
value string

Value to write
Returns:
Writer this

inherited uint32(value){ Writer }

writer.js, line 142

Writes an unsigned 32 bit value as a varint.

Parameters:
value number

Value to write
Returns:
Writer this

inherited uint32s(value){ Writer }

writer.js, line 404

Writes an array of unsigned 32 bit values as a packed repeated field.

Parameters:
value Array<number>

Values to write
Returns:
Writer this

inherited uint64(value){ Writer }

writer.js, line 197

Writes an unsigned 64 bit value as a varint.

Parameters:
value Long | number | string

Value to write
Throws:
TypeError

If value is a string and no long library is present.
Returns:
Writer this

inherited uint64s(value){ Writer }

writer.js, line 451

Writes an array of unsigned 64 bit values as a packed repeated field.

Parameters:
value Array<(Long|number|string)>

Values to write
Returns:
Writer this

BufferWriter.alloc(size){ Buffer }

writer_buffer.js, line 36

Allocates a buffer of the specified size.

Parameters:
size number

Buffer size
Returns:
Buffer Buffer