protobuf.js

API documentation

Class: BufferWriter

BufferWriter

Wire format writer using node buffers.

new BufferWriter()

src/writer_buffer.js, line 18

Constructs a new buffer writer instance.

Extends

Members

Operations head.

len { number }

Current length.

states { Object | null }

Linked forked states.

tail { Object }

Operations tail

Methods

BufferWriter.alloc(size){ Buffer }

src/writer_buffer.js, line 27

Allocates a buffer of the specified size.

Name Type Description
size number

Buffer size
Returns:
Type Description
Buffer Buffer

inherited bool(value){ Writer }

src/writer.js, line 287

Writes a boolish value as a varint.

Name Type Description
value boolean

Value to write
Returns:
Type Description
Writer this

inherited bytes(value){ Writer }

src/writer.js, line 370

Writes a sequence of bytes.

Name Type Description
value Uint8Array | string

Buffer or base64 encoded string to write
Returns:
Type Description
Writer this

inherited double(value){ Writer }

src/writer.js, line 351

Writes a double (64 bit float).

Name Type Description
value number

Value to write
Returns:
Type Description
Writer this

finish(){ Buffer }

src/writer_buffer.js, line 76

Finishes the write operation.

Returns:
Type Description
Buffer Finished buffer

inherited fixed32(value){ Writer }

src/writer.js, line 303

Writes an unsigned 32 bit value as fixed 32 bits.

Name Type Description
value number

Value to write
Returns:
Type Description
Writer this

inherited fixed64(value){ Writer }

src/writer.js, line 321

Writes an unsigned 64 bit value as fixed 64 bits.

Name Type Description
value Long | number | string

Value to write
Throws:
Type Description
TypeError

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

inherited float(value){ Writer }

src/writer.js, line 341

Writes a float (32 bit).

Name Type Description
value number

Value to write
Returns:
Type Description
Writer this

inherited fork(){ Writer }

src/writer.js, line 399

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

Returns:
Type Description
Writer this

inherited int32(value){ Writer }

src/writer.js, line 223

Writes a signed 32 bit value as a varint.

Name Type Description
value number

Value to write
Returns:
Type Description
Writer this

inherited int64(value){ Writer }

src/writer.js, line 269

Writes a signed 64 bit value as a varint.

Name Type Description
value Long | number | string

Value to write
Throws:
Type Description
TypeError

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

inherited ldelim(){ Writer }

src/writer.js, line 427

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

Returns:
Type Description
Writer this

inherited reset(){ Writer }

src/writer.js, line 410

Resets this instance to the last state.

Returns:
Type Description
Writer this

inherited sfixed32(value){ Writer }

src/writer.js, line 313

Writes a signed 32 bit value as fixed 32 bits.

Name Type Description
value number

Value to write
Returns:
Type Description
Writer this

inherited sfixed64(value){ Writer }

src/writer.js, line 333

Writes a signed 64 bit value as fixed 64 bits.

Name Type Description
value Long | number | string

Value to write
Throws:
Type Description
TypeError

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

inherited sint32(value){ Writer }

src/writer.js, line 234

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

Name Type Description
value number

Value to write
Returns:
Type Description
Writer this

inherited sint64(value){ Writer }

src/writer.js, line 277

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

Name Type Description
value Long | number | string

Value to write
Throws:
Type Description
TypeError

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

inherited string(value){ Writer }

src/writer.js, line 387

Writes a string.

Name Type Description
value string

Value to write
Returns:
Type Description
Writer this

inherited uint32(value){ Writer }

src/writer.js, line 203

Writes an unsigned 32 bit value as a varint.

Name Type Description
value number

Value to write
Returns:
Type Description
Writer this

inherited uint64(value){ Writer }

src/writer.js, line 257

Writes an unsigned 64 bit value as a varint.

Name Type Description
value Long | number | string

Value to write
Throws:
Type Description
TypeError

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