Class PropertyValue

Staticextensions

StaticextensionsBinary

clone

• clone(): this

  Returns this

cloneMessage

• cloneMessage(): this

  Returns this

getExtension

• getExtension<T>(fieldInfo: ExtensionFieldInfo<T>): T

  Type Parameters

  • T

  Parameters

  • fieldInfo: ExtensionFieldInfo<T>

  Returns T

getJsPbMessageId

• getJsPbMessageId(): undefined | string

  Returns undefined | string

readBinaryExtension

• readBinaryExtension(
      proto: Message,
      reader: BinaryReader,
      extensions: { [key: number]: ExtensionFieldBinaryInfo<Message> },
      setExtensionFn: <T>(fieldInfo: ExtensionFieldInfo<T>, val: T) => void,
  ): void

  Parameters

  • proto: Message
  • reader: BinaryReader
  • extensions: { [key: number]: ExtensionFieldBinaryInfo<Message> }
  • setExtensionFn: <T>(fieldInfo: ExtensionFieldInfo<T>, val: T) => void

  Returns void

serializeBinaryExtensions

• serializeBinaryExtensions(
      proto: Message,
      writer: BinaryWriter,
      extensions: { [key: number]: ExtensionFieldBinaryInfo<Message> },
      getExtensionFn: <T>(fieldInfo: ExtensionFieldInfo<T>) => T,
  ): void

  Parameters

  • proto: Message
  • writer: BinaryWriter
  • extensions: { [key: number]: ExtensionFieldBinaryInfo<Message> }
  • getExtensionFn: <T>(fieldInfo: ExtensionFieldInfo<T>) => T

  Returns void

setExtension

• setExtension<T>(fieldInfo: ExtensionFieldInfo<T>, value: T): void

  Type Parameters

  • T

  Parameters

  • fieldInfo: ExtensionFieldInfo<T>
  • value: T

  Returns void

toArray

• toArray(): MessageArray

  Returns MessageArray

toString

• toString(): string

  Returns string

StaticaddToRepeatedField

• addToRepeatedField(
      msg: Message,
      fieldNumber: number,
      value: any,
      index?: number,
  ): void

  Parameters

  • msg: Message
  • fieldNumber: number
  • value: any
  • Optionalindex: number

  Returns void

StaticaddToRepeatedWrapperField

• addToRepeatedWrapperField<T extends Message>(
      msg: Message,
      fieldNumber: number,
      value: undefined | T,
      ctor: new () => T,
      index?: number,
  ): T

  Type Parameters

  • T extends Message

  Parameters

  • msg: Message
  • fieldNumber: number
  • value: undefined | T
  • ctor: new () => T
  • Optionalindex: number

  Returns T

StaticbytesAsB64

• bytesAsB64(bytes: Uint8Array): string

  Parameters

  • bytes: Uint8Array

  Returns string

StaticbytesAsU8

• bytesAsU8(str: string): Uint8Array

  Parameters

  • str: string

  Returns Uint8Array

StaticbytesListAsB64

• bytesListAsB64(bytesList: Uint8Array<ArrayBufferLike>[]): string[]

  Parameters

  • bytesList: Uint8Array<ArrayBufferLike>[]

  Returns string[]

StaticbytesListAsU8

• bytesListAsU8(strList: string[]): Uint8Array<ArrayBufferLike>[]

  Parameters

  • strList: string[]

  Returns Uint8Array<ArrayBufferLike>[]

Staticclone

• clone<T extends Message>(msg: T): T

  Type Parameters

  • T extends Message

  Parameters

  • msg: T

  Returns T

StaticcloneMessage

• cloneMessage<T extends Message>(msg: T): T

  Type Parameters

  • T extends Message

  Parameters

  • msg: T

  Returns T

StaticcompareExtensions

• compareExtensions(extension1: {}, extension2: {}): boolean

  Parameters

  • extension1: {}
  • extension2: {}

  Returns boolean

StaticcompareFields

• compareFields(field1: any, field2: any): boolean

  Parameters

  • field1: any
  • field2: any

  Returns boolean

StaticcomputeOneofCase

• computeOneofCase(msg: Message, oneof: number[]): number

  Parameters

  • msg: Message
  • oneof: number[]

  Returns number

StaticcopyInto

• copyInto(fromMessage: Message, toMessage: Message): void

  Parameters

  • fromMessage: Message
  • toMessage: Message

  Returns void

StaticdeserializeBinaryFromReader

• deserializeBinaryFromReader(message: Message, reader: BinaryReader): Message

  Parameters

  • message: Message
  • reader: BinaryReader

  Returns Message

Staticdifference

• difference<T extends Message>(m1: T, m2: T): T

  Type Parameters

  • T extends Message

  Parameters

  • m1: T
  • m2: T

  Returns T

Staticequals

• equals(m1: Message, m2: Message): boolean

  Parameters

  • m1: Message
  • m2: Message

  Returns boolean

StaticgetField

• getField(msg: Message, fieldNumber: number): null | FieldValue

  Parameters

  • msg: Message
  • fieldNumber: number

  Returns null | FieldValue

StaticgetFieldWithDefault

• getFieldWithDefault<T>(msg: Message, fieldNumber: number, defaultValue: T): T

  Type Parameters

  • T

  Parameters

  • msg: Message
  • fieldNumber: number
  • defaultValue: T

  Returns T

StaticgetMapField

• getMapField(
      msg: Message,
      fieldNumber: number,
      noLazyCreate: boolean,
      valueCtor?: typeof Message,
  ): Map<any, any>

  Parameters

  • msg: Message
  • fieldNumber: number
  • noLazyCreate: boolean
  • OptionalvalueCtor: typeof Message

  Returns Map<any, any>

StaticgetOptionalFloatingPointField

• getOptionalFloatingPointField(
      msg: Message,
      fieldNumber: number,
  ): undefined | number

  Parameters

  • msg: Message
  • fieldNumber: number

  Returns undefined | number

StaticgetRepeatedFloatingPointField

• getRepeatedFloatingPointField(msg: Message, fieldNumber: number): number[]

  Parameters

  • msg: Message
  • fieldNumber: number

  Returns number[]

StaticgetRepeatedWrapperField

• getRepeatedWrapperField<T extends Message>(
      msg: Message,
      ctor: new () => T,
      fieldNumber: number,
  ): T[]

  Type Parameters

  • T extends Message

  Parameters

  • msg: Message
  • ctor: new () => T
  • fieldNumber: number

  Returns T[]

StaticgetWrapperField

• getWrapperField<T extends Message>(
      msg: Message,
      ctor: new () => T,
      fieldNumber: number,
      required?: number,
  ): T

  Type Parameters

  • T extends Message

  Parameters

  • msg: Message
  • ctor: new () => T
  • fieldNumber: number
  • Optionalrequired: number

  Returns T

Staticinitialize

• initialize(
      msg: Message,
      data: MessageArray,
      messageId: string | number,
      suggestedPivot: number,
      repeatedFields?: null | number[],
      oneofFields?: null | number[][],
  ): void

  Parameters

  • msg: Message
  • data: MessageArray
  • messageId: string | number
  • suggestedPivot: number
  • OptionalrepeatedFields: null | number[]
  • OptionaloneofFields: null | number[][]

  Returns void

StaticregisterMessageType

• registerMessageType(id: number, constructor: typeof Message): void

  Parameters

  • id: number
  • constructor: typeof Message

  Returns void

StaticserializeBinaryToWriter

• serializeBinaryToWriter(message: Message, writer: BinaryWriter): void

  Parameters

  • message: Message
  • writer: BinaryWriter

  Returns void

StaticsetField

• setField(msg: Message, fieldNumber: number, value: ReadonlyFieldValue): void

  Parameters

  • msg: Message
  • fieldNumber: number
  • value: ReadonlyFieldValue

  Returns void

StaticsetOneofField

• setOneofField(
      msg: Message,
      fieldNumber: number,
      oneof: number[],
      value: ReadonlyFieldValue,
  ): void

  Parameters

  • msg: Message
  • fieldNumber: number
  • oneof: number[]
  • value: ReadonlyFieldValue

  Returns void

StaticsetOneofWrapperField

• setOneofWrapperField(
      msg: Message,
      fieldNumber: number,
      oneof: number[],
      value: any,
  ): void

  Parameters

  • msg: Message
  • fieldNumber: number
  • oneof: number[]
  • value: any

  Returns void

StaticsetRepeatedWrapperField

• setRepeatedWrapperField<T extends Message>(
      msg: Message,
      fieldNumber: number,
      value?: readonly T[],
  ): void

  Type Parameters

  • T extends Message

  Parameters

  • msg: Message
  • fieldNumber: number
  • Optionalvalue: readonly T[]

  Returns void

StaticsetWrapperField

• setWrapperField<T extends Message>(
      msg: Message,
      fieldNumber: number,
      value?: Map<any, any> | T,
  ): void

  Type Parameters

  • T extends Message

  Parameters

  • msg: Message
  • fieldNumber: number
  • Optionalvalue: Map<any, any> | T

  Returns void

StatictoMap

• toMap(
      field: any[],
      mapKeyGetterFn: (field: any) => string,
      toObjectFn?: StaticToObject,
      includeInstance?: boolean,
  ): void

  Parameters

  • field: any[]
  • mapKeyGetterFn: (field: any) => string
  • OptionaltoObjectFn: StaticToObject
  • OptionalincludeInstance: boolean

  Returns void

StatictoObject

• toObject(includeInstance: boolean, msg: Message): {}

  Parameters

  • includeInstance: boolean
  • msg: Message

  Returns {}

StatictoObjectExtension

• toObjectExtension(
      msg: Message,
      obj: {},
      extensions: { [key: number]: ExtensionFieldInfo<Message> },
      getExtensionFn: (fieldInfo: ExtensionFieldInfo<Message>) => Message,
      includeInstance?: boolean,
  ): void

  Parameters

  • msg: Message
  • obj: {}
  • extensions: { [key: number]: ExtensionFieldInfo<Message> }
  • getExtensionFn: (fieldInfo: ExtensionFieldInfo<Message>) => Message
  • OptionalincludeInstance: boolean

  Returns void

StatictoObjectList

• toObjectList<T extends Message>(
      field: T[],
      toObjectFn: (includeInstance: boolean, data: T) => {},
      includeInstance?: boolean,
  ): {}[]

  Type Parameters

  • T extends Message

  Parameters

  • field: T[]
  • toObjectFn: (includeInstance: boolean, data: T) => {}
  • OptionalincludeInstance: boolean

  Returns {}[]