Skip to main content

Class: SyncdRecord

Defined in: WAProto/index.d.ts:50322

Represents a SyncdRecord.

Implements​

Constructors​

new SyncdRecord()​

new SyncdRecord(properties?): SyncdRecord

Defined in: WAProto/index.d.ts:50328

Constructs a new SyncdRecord.

Parameters​

properties?​

ISyncdRecord

Properties to set

Returns​

SyncdRecord

Properties​

index?​

optional index: null | ISyncdIndex

Defined in: WAProto/index.d.ts:50331

SyncdRecord index.

Implementation of​

ISyncdRecord.index

keyId?​

optional keyId: null | IKeyId

Defined in: WAProto/index.d.ts:50337

SyncdRecord keyId.

Implementation of​

ISyncdRecord.keyId

value?​

optional value: null | ISyncdValue

Defined in: WAProto/index.d.ts:50334

SyncdRecord value.

Implementation of​

ISyncdRecord.value

Methods​

toJSON()​

toJSON(): object

Defined in: WAProto/index.d.ts:50407

Converts this SyncdRecord to JSON.

Returns​

object

JSON object

create()​

static create(properties?): SyncdRecord

Defined in: WAProto/index.d.ts:50344

Creates a new SyncdRecord instance using the specified properties.

Parameters​

properties?​

ISyncdRecord

Properties to set

Returns​

SyncdRecord

SyncdRecord instance

decode()​

static decode(reader, length?): SyncdRecord

Defined in: WAProto/index.d.ts:50370

Decodes a SyncdRecord message from the specified reader or buffer.

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

length?​

number

Message length if known beforehand

Returns​

SyncdRecord

SyncdRecord

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): SyncdRecord

Defined in: WAProto/index.d.ts:50379

Decodes a SyncdRecord message from the specified reader or buffer, length delimited.

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns​

SyncdRecord

SyncdRecord

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Defined in: WAProto/index.d.ts:50352

Encodes the specified SyncdRecord message. Does not implicitly verify messages.

Parameters​

message​

ISyncdRecord

SyncdRecord message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Defined in: WAProto/index.d.ts:50360

Encodes the specified SyncdRecord message, length delimited. Does not implicitly verify messages.

Parameters​

message​

ISyncdRecord

SyncdRecord message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): SyncdRecord

Defined in: WAProto/index.d.ts:50393

Creates a SyncdRecord message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

SyncdRecord

SyncdRecord

getTypeUrl()​

static getTypeUrl(typeUrlPrefix?): string

Defined in: WAProto/index.d.ts:50414

Gets the default type url for SyncdRecord

Parameters​

typeUrlPrefix?​

string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns​

string

The default type url

toObject()​

static toObject(message, options?): object

Defined in: WAProto/index.d.ts:50401

Creates a plain object from a SyncdRecord message. Also converts values to other types if specified.

Parameters​

message​

SyncdRecord

SyncdRecord

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object

verify()​

static verify(message): null | string

Defined in: WAProto/index.d.ts:50386

Verifies a SyncdRecord message.

Parameters​

message​

Plain object to verify

Returns​

null | string

null if valid, otherwise the reason why it is not