protobuf.js

API documentation

Class: Reader

Reader

Wire format reader using Uint8Array.

new Reader(buffer)

reader.js, line 22

Constructs a new reader instance using the specified buffer.

Parameters:
buffer Uint8Array

Buffer to read from

Members

buf { Uint8Array }

reader.js, line 28

Read buffer.

discardUnknown { boolean }

reader.js, line 52

Whether to discard unknown fields while decoding.

len { number }

reader.js, line 40

Read buffer length.

pos { number }

reader.js, line 34

Read buffer position.

view { DataView | null }

reader.js, line 46

Cached DataView for packed reads.

Reader.discardUnknown { boolean }

reader.js, line 708

Whether readers discard unknown fields while decoding.

Reader.recursionLimit { number }

reader.js, line 702

Recursion limit.

Methods

bool(){ boolean }

reader.js, line 282

Reads a varint as a boolean.

Returns:
boolean Value read

bools(array){ Array<boolean> }

reader.js, line 435

Reads a packed repeated field of booleans.

Parameters:
array Array<boolean> optional

Array to read into; a new one is created if omitted
Returns:
Array<boolean> Array read into

bytes(){ Uint8Array }

reader.js, line 630

Reads a sequence of bytes preceeded by its length as a varint.

Returns:
Uint8Array Value read

double(){ number }

reader.js, line 380

Reads a double (64 bit float) as a number.

Returns:
number Value read

doubles(array){ Array<number> }

reader.js, line 532

Reads a packed repeated field of doubles (64 bit float).

Parameters:
array Array<number> optional

Array to read into; a new one is created if omitted
Returns:
Array<number> Array read into

fixed32(){ number }

reader.js, line 310

Reads fixed 32 bits as an unsigned 32 bit integer.

Returns:
number Value read

fixed32s(array){ Array<number> }

reader.js, line 460

Reads a packed repeated field of unsigned 32 bit fixed values.

Parameters:
array Array<number> optional

Array to read into; a new one is created if omitted
Returns:
Array<number> Array read into

fixed64(){ Long }

reader.js, line 345

Reads fixed 64 bits.

Returns:
Long Value read

fixed64s(array){ Array<(Long|number)> }

reader.js, line 595

Reads a packed repeated field of unsigned 64 bit fixed values.

Parameters:
array Array<(Long|number)> optional

Array to read into; a new one is created if omitted
Returns:
Array<(Long|number)> Array read into

float(){ number }

reader.js, line 364

Reads a float (32 bit) as a number.

Returns:
number Value read

floats(array){ Array<number> }

reader.js, line 508

Reads a packed repeated field of floats (32 bit).

Parameters:
array Array<number> optional

Array to read into; a new one is created if omitted
Returns:
Array<number> Array read into

int32(){ number }

reader.js, line 189

Reads a varint as a signed 32 bit value.

Returns:
number Value read

int32s(array){ Array<number> }

reader.js, line 409

Reads a packed repeated field of signed 32 bit varints.

Parameters:
array Array<number> optional

Array to read into; a new one is created if omitted
Returns:
Array<number> Array read into

int64(){ Long }

reader.js, line 257

Reads a varint as a signed 64 bit value.

Returns:
Long Value read

int64s(array){ Array<(Long|number)> }

reader.js, line 569

Reads a packed repeated field of signed 64 bit varints.

Parameters:
array Array<(Long|number)> optional

Array to read into; a new one is created if omitted
Returns:
Array<(Long|number)> Array read into

raw(start, end){ Uint8Array }

reader.js, line 93

Returns raw bytes from the backing buffer without advancing the reader.

Parameters:
start number

Start offset
end number

End offset
Returns:
Uint8Array Raw bytes

sfixed32(){ number }

reader.js, line 323

Reads fixed 32 bits as a signed 32 bit integer.

Returns:
number Value read

sfixed32s(array){ Array<number> }

reader.js, line 484

Reads a packed repeated field of signed 32 bit fixed values.

Parameters:
array Array<number> optional

Array to read into; a new one is created if omitted
Returns:
Array<number> Array read into

sfixed64(){ Long }

reader.js, line 352

Reads zig-zag encoded fixed 64 bits.

Returns:
Long Value read

sfixed64s(array){ Array<(Long|number)> }

reader.js, line 613

Reads a packed repeated field of signed 64 bit fixed values.

Parameters:
array Array<(Long|number)> optional

Array to read into; a new one is created if omitted
Returns:
Array<(Long|number)> Array read into

sint32(){ number }

reader.js, line 197

Reads a zig-zag encoded varint as a signed 32 bit value.

Returns:
number Value read

sint32s(array){ Array<number> }

reader.js, line 422

Reads a packed repeated field of zig-zag encoded signed 32 bit varints.

Parameters:
array Array<number> optional

Array to read into; a new one is created if omitted
Returns:
Array<number> Array read into

sint64(){ Long }

reader.js, line 271

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

Returns:
Long Value read

sint64s(array){ Array<(Long|number)> }

reader.js, line 582

Reads a packed repeated field of zig-zag encoded signed 64 bit varints.

Parameters:
array Array<(Long|number)> optional

Array to read into; a new one is created if omitted
Returns:
Array<(Long|number)> Array read into

skip(length){ Reader }

reader.js, line 682

Skips the specified number of bytes if specified, otherwise skips a varint.

Parameters:
length number optional

Length if known, otherwise a varint is assumed
Returns:
Reader this

skipType(wireType, depth, fieldNumber){ Reader }

reader.js, line 717

Skips the next element of the specified wire type.

Parameters:
wireType number

Wire type received
depth number optional

Depth of recursion to control nested calls; 0 if omitted
fieldNumber number optional

Field number for validating group end tags
Returns:
Reader this

string(){ string }

reader.js, line 647

Reads a string preceeded by its byte length as a varint.

Returns:
string Value read

stringVerify(){ string }

reader.js, line 664

Reads a string preceeded by its byte length as a varint, rejecting invalid UTF8.

Returns:
string Value read

tag(){ number }

reader.js, line 152

Reads a field tag.

Returns:
number Tag read

uint32(){ number }

reader.js, line 102

Reads a varint as an unsigned 32 bit value.

Returns:
number Value read

uint32s(array){ Array<number> }

reader.js, line 396

Reads a packed repeated field of unsigned 32 bit varints.

Parameters:
array Array<number> optional

Array to read into; a new one is created if omitted
Returns:
Array<number> Array read into

uint64(){ Long }

reader.js, line 264

Reads a varint as an unsigned 64 bit value.

Returns:
Long Value read

uint64s(array){ Array<(Long|number)> }

reader.js, line 556

Reads a packed repeated field of unsigned 64 bit varints.

Parameters:
array Array<(Long|number)> optional

Array to read into; a new one is created if omitted
Returns:
Array<(Long|number)> Array read into

Reader.create(buffer){ Reader | BufferReader }

reader.js, line 85

Creates a new reader using the specified buffer.

Parameters:
buffer Uint8Array | Buffer

Buffer to read from
Throws:
Error

If buffer is not a valid buffer
Returns:
Reader | BufferReader A BufferReader if buffer is a Buffer, otherwise a Reader