Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Batch

Hierarchy

  • Message
    • Batch

Index

Interfaces

Type aliases

Properties

Methods

Type aliases

Static AsObject

AsObject: { anchorType: TypeMap[keyof TypeMap]; createdAt?: google_protobuf_timestamp_pb.Timestamp.AsObject; data: string; error: string; finalizedAt?: google_protobuf_timestamp_pb.Timestamp.AsObject; flushedAt?: google_protobuf_timestamp_pb.Timestamp.AsObject; hash: string; id: string; proofFormat: FormatMap[keyof FormatMap]; size: number; startedAt?: google_protobuf_timestamp_pb.Timestamp.AsObject; status: StatusMap[keyof StatusMap]; submittedAt?: google_protobuf_timestamp_pb.Timestamp.AsObject }

Type declaration

  • anchorType: TypeMap[keyof TypeMap]
  • Optional createdAt?: google_protobuf_timestamp_pb.Timestamp.AsObject
  • data: string
  • error: string
  • Optional finalizedAt?: google_protobuf_timestamp_pb.Timestamp.AsObject
  • Optional flushedAt?: google_protobuf_timestamp_pb.Timestamp.AsObject
  • hash: string
  • id: string
  • proofFormat: FormatMap[keyof FormatMap]
  • size: number
  • Optional startedAt?: google_protobuf_timestamp_pb.Timestamp.AsObject
  • status: StatusMap[keyof StatusMap]
  • Optional submittedAt?: google_protobuf_timestamp_pb.Timestamp.AsObject

Static MessageArray

MessageArray: any[]

Static StaticToObject

StaticToObject: (includeInstance: boolean, msg: Message) => {}

Type declaration

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

    • Parameters

      • includeInstance: boolean
      • msg: Message

      Returns {}

Static ValueOfStatus

ValueOfStatus: StatusMap[keyof StatusMap]

Properties

Static Status

Status: StatusMap

Static StatusName

StatusName: Record<ValueOfStatus, string>

Static extensions

extensions: {}

Type declaration

  • [key: number]: ExtensionFieldInfo<Message>

Static extensionsBinary

extensionsBinary: {}

Type declaration

  • [key: number]: ExtensionFieldBinaryInfo<Message>

Methods

clearCreatedAt

  • clearCreatedAt(): void

clearFinalizedAt

  • clearFinalizedAt(): void

clearFlushedAt

  • clearFlushedAt(): void

clearStartedAt

  • clearStartedAt(): void

clearSubmittedAt

  • clearSubmittedAt(): void

clone

  • clone(): this

  • Returns this

cloneMessage

  • cloneMessage(): this

  • Returns this

getAnchorType

  • getAnchorType(): TypeMap[keyof TypeMap]

getCreatedAt

  • getCreatedAt(): Timestamp | undefined

getData

  • getData(): string

getError

  • getError(): string

getExtension

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

  • Type parameters

    • T

    Parameters

    • fieldInfo: ExtensionFieldInfo<T>

    Returns T

getFinalizedAt

  • getFinalizedAt(): Timestamp | undefined

getFlushedAt

  • getFlushedAt(): Timestamp | undefined

getHash

  • getHash(): string

getId

  • getId(): string

getJsPbMessageId

  • getJsPbMessageId(): undefined | string

  • Returns undefined | string

getProofFormat

  • getProofFormat(): FormatMap[keyof FormatMap]

getSize

  • getSize(): number

getStartedAt

  • getStartedAt(): Timestamp | undefined

getStatus

  • getStatus(): StatusMap[keyof StatusMap]

getSubmittedAt

  • getSubmittedAt(): Timestamp | undefined

hasCreatedAt

  • hasCreatedAt(): boolean

hasFinalizedAt

  • hasFinalizedAt(): boolean

hasFlushedAt

  • hasFlushedAt(): boolean

hasStartedAt

  • hasStartedAt(): boolean

hasSubmittedAt

  • hasSubmittedAt(): boolean

readBinaryExtension

  • readBinaryExtension(proto: Message, reader: BinaryReader, extensions: {}, 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
        • <T>(fieldInfo: ExtensionFieldInfo<T>, val: T): void

        • Type parameters

          • T

          Parameters

          • fieldInfo: ExtensionFieldInfo<T>
          • val: T

          Returns void

    Returns void

serializeBinary

  • serializeBinary(): Uint8Array

serializeBinaryExtensions

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

  • Parameters

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

        • Type parameters

          • T

          Parameters

          • fieldInfo: ExtensionFieldInfo<T>

          Returns T

    Returns void

setAnchorType

  • setAnchorType(value: TypeMap[keyof TypeMap]): void

setCreatedAt

  • setCreatedAt(value?: google_protobuf_timestamp_pb.Timestamp): void

setData

  • setData(value: string): void

setError

  • setError(value: string): void

setExtension

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

  • Type parameters

    • T

    Parameters

    • fieldInfo: ExtensionFieldInfo<T>
    • value: T

    Returns void

setFinalizedAt

  • setFinalizedAt(value?: google_protobuf_timestamp_pb.Timestamp): void

setFlushedAt

  • setFlushedAt(value?: google_protobuf_timestamp_pb.Timestamp): void

setHash

  • setHash(value: string): void

setId

  • setId(value: string): void

setProofFormat

  • setProofFormat(value: FormatMap[keyof FormatMap]): void

setSize

  • setSize(value: number): void

setStartedAt

  • setStartedAt(value?: google_protobuf_timestamp_pb.Timestamp): void

setStatus

  • setStatus(value: StatusMap[keyof StatusMap]): void

setSubmittedAt

  • setSubmittedAt(value?: google_protobuf_timestamp_pb.Timestamp): void

toArray

  • toArray(): Message.MessageArray

  • Returns Message.MessageArray

toObject

  • toObject(includeInstance?: undefined | false | true): AsObject

toString

  • toString(): string

  • Returns string

Static addToRepeatedField

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

  • Parameters

    • msg: Message
    • fieldNumber: number
    • value: any
    • Optional index: undefined | number

    Returns void

Static addToRepeatedWrapperField

  • addToRepeatedWrapperField<T>(msg: Message, fieldNumber: number, value: T | undefined, ctor: { constructor: any }, index?: undefined | number): T

  • Type parameters

    • T: Message

    Parameters

    • msg: Message
    • fieldNumber: number
    • value: T | undefined
    • ctor: { constructor: any }
      • constructor: function
        • new __type(): T

        • Returns T

    • Optional index: undefined | number

    Returns T

Static bytesAsB64

  • bytesAsB64(bytes: Uint8Array): string

  • Parameters

    • bytes: Uint8Array

    Returns string

Static bytesAsU8

  • bytesAsU8(str: string): Uint8Array

  • Parameters

    • str: string

    Returns Uint8Array

Static bytesListAsB64

  • bytesListAsB64(bytesList: Uint8Array[]): string[]

  • Parameters

    • bytesList: Uint8Array[]

    Returns string[]

Static bytesListAsU8

  • bytesListAsU8(strList: string[]): Uint8Array[]

  • Parameters

    • strList: string[]

    Returns Uint8Array[]

Static clone

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

  • Type parameters

    • T: Message

    Parameters

    • msg: T

    Returns T

Static cloneMessage

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

  • Type parameters

    • T: Message

    Parameters

    • msg: T

    Returns T

Static compareExtensions

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

  • Parameters

    • extension1: {}
    • extension2: {}

    Returns boolean

Static compareFields

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

  • Parameters

    • field1: any
    • field2: any

    Returns boolean

Static computeOneofCase

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

  • Parameters

    • msg: Message
    • oneof: number[]

    Returns number

Static copyInto

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

  • Parameters

    • fromMessage: Message
    • toMessage: Message

    Returns void

Static deserializeBinary

  • deserializeBinary(bytes: Uint8Array): Batch

Static deserializeBinaryFromReader

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

Static difference

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

  • Type parameters

    • T: Message

    Parameters

    • m1: T
    • m2: T

    Returns T

Static equals

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

  • Parameters

    • m1: Message
    • m2: Message

    Returns boolean

Static getField

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

  • Parameters

    • msg: Message
    • fieldNumber: number

    Returns FieldValue | null

Static getFieldWithDefault

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

  • Type parameters

    • T

    Parameters

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

    Returns T

Static getMapField

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

  • Parameters

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

    Returns Map<any, any>

Static getOptionalFloatingPointField

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

  • Parameters

    • msg: Message
    • fieldNumber: number

    Returns number | undefined

Static getRepeatedFloatingPointField

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

  • Parameters

    • msg: Message
    • fieldNumber: number

    Returns number[]

Static getRepeatedWrapperField

  • getRepeatedWrapperField<T>(msg: Message, ctor: { constructor: any }, fieldNumber: number): T[]

  • Type parameters

    • T: Message

    Parameters

    • msg: Message
    • ctor: { constructor: any }
      • constructor: function
        • new __type(): T

        • Returns T

    • fieldNumber: number

    Returns T[]

Static getWrapperField

  • getWrapperField<T>(msg: Message, ctor: { constructor: any }, fieldNumber: number, required?: undefined | number): T

  • Type parameters

    • T: Message

    Parameters

    • msg: Message
    • ctor: { constructor: any }
      • constructor: function
        • new __type(): T

        • Returns T

    • fieldNumber: number
    • Optional required: undefined | number

    Returns T

Static initialize

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

  • Parameters

    • msg: Message
    • data: Message.MessageArray
    • messageId: string | number
    • suggestedPivot: number
    • Optional repeatedFields: number[]
    • Optional oneofFields: number[][] | null

    Returns void

Static registerMessageType

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

  • Parameters

    • id: number
    • constructor: typeof Message

    Returns void

Static serializeBinaryToWriter

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

Static setField

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

  • Parameters

    • msg: Message
    • fieldNumber: number
    • value: FieldValue

    Returns void

Static setOneofField

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

  • Parameters

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

    Returns void

Static setOneofWrapperField

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

  • Parameters

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

    Returns void

Static setRepeatedWrapperField

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

  • Type parameters

    • T: Message

    Parameters

    • msg: Message
    • fieldNumber: number
    • Optional value: T[]

    Returns void

Static setWrapperField

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

  • Type parameters

    • T: Message

    Parameters

    • msg: Message
    • fieldNumber: number
    • Optional value: undefined | Map<any, any> | T

    Returns void

Static toMap

  • toMap(field: any[], mapKeyGetterFn: (field: any) => string, toObjectFn?: Message.StaticToObject, includeInstance?: undefined | false | true): void

  • Parameters

    • field: any[]
    • mapKeyGetterFn: (field: any) => string
        • (field: any): string

        • Parameters

          • field: any

          Returns string

    • Optional toObjectFn: Message.StaticToObject
    • Optional includeInstance: undefined | false | true

    Returns void

Static toObject

Static toObjectExtension

  • toObjectExtension(msg: Message, obj: {}, extensions: {}, getExtensionFn: (fieldInfo: ExtensionFieldInfo<Message>) => Message, includeInstance?: undefined | false | true): void

  • Parameters

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

        • Parameters

          • fieldInfo: ExtensionFieldInfo<Message>

          Returns Message

    • Optional includeInstance: undefined | false | true

    Returns void

Static toObjectList

  • toObjectList<T>(field: T[], toObjectFn: (includeInstance: boolean, data: T) => {}, includeInstance?: undefined | false | true): Array<{}>

  • Type parameters

    • T: Message

    Parameters

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

        • Parameters

          • includeInstance: boolean
          • data: T

          Returns {}

    • Optional includeInstance: undefined | false | true

    Returns Array<{}>

Generated using TypeDoc