protobuf.js

API documentation

Class: Writer

Writer

Wire format writer using Uint8Array.

new Writer()

writer.js, line 17

Constructs a new writer instance.

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

bool(value){ Writer }

writer.js, line 233

Writes a boolish value as a varint.

Parameters:
value boolean

Value to write
Returns:
Writer this

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

bytes(value){ Writer }

writer.js, line 321

Writes a sequence of bytes.

Parameters:
value Uint8Array | string

Buffer or base64 encoded string to write
Returns:
Writer this

double(value){ Writer }

writer.js, line 309

Writes a double (64 bit float).

Parameters:
value number

Value to write
Returns:
Writer this

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(shared){ Uint8Array }

writer.js, line 672

Finishes the write operation.
Returns a buffer sized to the written data by default.

Parameters:
shared boolean false optional

Whether to return a shared view instead of a unique copy
Returns:
Uint8Array Finished buffer

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

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

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

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

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

float(value){ Writer }

writer.js, line 296

Writes a float (32 bit).

Parameters:
value number

Value to write
Returns:
Writer this

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

fork(){ Writer }

writer.js, line 612

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

Returns:
Writer this

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

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

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

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

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

raw(value){ Writer }

writer.js, line 345

Writes raw bytes without a tag or length prefix.

Parameters:
value Uint8Array

Raw bytes
Returns:
Writer this

reset(){ Writer }

writer.js, line 623

Resets this instance to the last state.

Returns:
Writer this

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

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

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

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

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

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

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

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

string(value){ Writer }

writer.js, line 376

Writes a string.

Parameters:
value string

Value to write
Returns:
Writer this

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

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

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

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

Writer.alloc(size){ Uint8Array }

writer.js, line 83

Allocates a buffer of the specified size.

Parameters:
size number

Buffer size
Returns:
Uint8Array Buffer

Writer.create(){ BufferWriter | Writer }

writer.js, line 76

Creates a new writer.

Returns:
BufferWriter | Writer A BufferWriter when Buffers are supported, otherwise a Writer