Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyncdRecord

Represents a SyncdRecord.

Hierarchy

  • SyncdRecord

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional index

index: ISyncdIndex

SyncdRecord index.

Optional keyId

keyId: IKeyId

SyncdRecord keyId.

Optional value

value: ISyncdValue

SyncdRecord value.

Methods

toJSON

  • toJSON(): {}

Static create

Static decode

  • decode(reader: Uint8Array | Reader, length?: number): SyncdRecord

  • Decodes a SyncdRecord message from the specified reader or buffer.

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    • Optional length: number

    Returns SyncdRecord

    SyncdRecord

Static decodeDelimited

  • decodeDelimited(reader: Uint8Array | Reader): SyncdRecord

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

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns SyncdRecord

    SyncdRecord

Static encode

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

    Parameters

    • message: ISyncdRecord

      SyncdRecord message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static encodeDelimited

  • encodeDelimited(message: ISyncdRecord, writer?: Writer): Writer

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

    Parameters

    • message: ISyncdRecord

      SyncdRecord message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static fromObject

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

    Parameters

    • object: {}

      Plain object

      • [k: string]: any

    Returns SyncdRecord

    SyncdRecord

Static toObject

  • toObject(message: SyncdRecord, options?: IConversionOptions): {}

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

    Parameters

    • message: SyncdRecord

      SyncdRecord

    • Optional options: IConversionOptions

    Returns {}

    Plain object

    • [k: string]: any

Static verify

  • verify(message: {}): string

  • Verifies a SyncdRecord message.

    Parameters

    • message: {}

      Plain object to verify

      • [k: string]: any

    Returns string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc