protobuf.js

API documentation

Class: BufferWriter

BufferWriter

Wire format writer using node buffers.

new BufferWriter()

writer_buffer.js, line 16

Constructs a new buffer writer instance.

Extends

Members

writer.js, line 103

Operations head.

len { number }

writer.js, line 97

Current length.

states { Object | null }

writer.js, line 115

Linked forked states.

tail { Object }

writer.js, line 109

Operations tail

Methods

inherited bool(value){ Writer }

writer.js, line 296

Writes a boolish value as a varint.

Parameters:
value boolean

Value to write
Returns:
Writer this

inherited bytes(value){ Writer }

writer_buffer.js, line 47

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 360

Writes a double (64 bit float).

Parameters:
value number

Value to write
Returns:
Writer this

finish(){ Buffer }

writer_buffer.js, line 95

Finishes the write operation.

Returns:
Buffer Finished buffer

inherited finishInto(buf, offset){ T }

writer.js, line 476

Finishes the write operation, writing into the provided buffer.
The caller must ensure that buf has enough space starting at offset
to hold Writer#len 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 312

Writes an unsigned 32 bit value as fixed 32 bits.

Parameters:
value number

Value to write
Returns:
Writer this

inherited fixed64(value){ Writer }

writer.js, line 330

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 float(value){ Writer }

writer.js, line 350

Writes a float (32 bit).

Parameters:
value number

Value to write
Returns:
Writer this

inherited fork(){ Writer }

writer.js, line 418

Forks this writer's state by pushing it to a stack.
Calling reset or ldelim resets the writer to the previous state.

Returns:
Writer this

inherited int32(value){ Writer }

writer.js, line 232

Writes a signed 32 bit value as a varint.

Parameters:
value number

Value to write
Returns:
Writer this

inherited int64(value){ Writer }

writer.js, line 278

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 ldelim(){ Writer }

writer.js, line 446

Resets to the last state and appends the fork state's current write length as a varint followed by its operations.

Returns:
Writer this

raw(value){ BufferWriter }

writer_buffer.js, line 57

Writes raw bytes without a tag or length prefix.

Parameters:
value Uint8Array

Raw bytes
Returns:
BufferWriter this

inherited reset(){ Writer }

writer.js, line 429

Resets this instance to the last state.

Returns:
Writer this

inherited sfixed32(value){ Writer }

writer.js, line 322

Writes a signed 32 bit value as fixed 32 bits.

Parameters:
value number

Value to write
Returns:
Writer this

inherited sfixed64(value){ Writer }

writer.js, line 342

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 sint32(value){ Writer }

writer.js, line 243

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

Parameters:
value number

Value to write
Returns:
Writer this

inherited sint64(value){ Writer }

writer.js, line 286

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 string(value){ Writer }

writer_buffer.js, line 86

Writes a string.

Parameters:
value string

Value to write
Returns:
Writer this

inherited uint32(value){ Writer }

writer.js, line 212

Writes an unsigned 32 bit value as a varint.

Parameters:
value number

Value to write
Returns:
Writer this

inherited uint64(value){ Writer }

writer.js, line 266

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

BufferWriter.alloc(size){ Buffer }

writer_buffer.js, line 27

Allocates a buffer of the specified size.

Parameters:
size number

Buffer size
Returns:
Buffer Buffer