Options
All
  • Public
  • Public/Protected
  • All
Menu

Provides means of writing compact serialized fields to the binary data.

This API is currently in Beta and can change at any time.

Hierarchy

  • CompactWriter

Index

Methods

  • writeArrayOfBoolean(fieldName: string, value: boolean[]): void
  • Writes an array of booleans.

    Parameters

    • fieldName: string

      name of the field.

    • value: boolean[]

      to be written.

    Returns void

  • writeArrayOfCompact<T>(fieldName: string, value: T[]): void
  • Writes an array of nested compact objects.

    Type parameters

    • T

    Parameters

    • fieldName: string

      name of the field.

    • value: T[]

      to be written.

    Returns void

  • writeArrayOfDate(fieldName: string, value: LocalDate[]): void
  • Writes an array of LocalDate.

    Parameters

    • fieldName: string

      name of the field.

    • value: LocalDate[]

      to be written.

    Returns void

  • writeArrayOfDecimal(fieldName: string, value: BigDecimal[]): void
  • Writes an array of BigDecimal.

    Parameters

    • fieldName: string

      name of the field.

    • value: BigDecimal[]

      to be written.

    Returns void

  • writeArrayOfFloat32(fieldName: string, value: number[]): void
  • Writes an array of 32-bit IEEE 754 floating point numbers.

    Parameters

    • fieldName: string

      name of the field.

    • value: number[]

      to be written.

    Returns void

  • writeArrayOfFloat64(fieldName: string, value: number[]): void
  • Writes an array of 64-bit IEEE 754 floating point numbers.

    Parameters

    • fieldName: string

      name of the field.

    • value: number[]

      to be written.

    Returns void

  • writeArrayOfInt16(fieldName: string, value: number[]): void
  • Writes an array of 16-bit two's complement signed integers.

    Parameters

    • fieldName: string

      name of the field.

    • value: number[]

      to be written.

    Returns void

  • writeArrayOfInt32(fieldName: string, value: number[]): void
  • Writes an array of 32-bit two's complement signed integers.

    Parameters

    • fieldName: string

      name of the field.

    • value: number[]

      to be written.

    Returns void

  • writeArrayOfInt64(fieldName: string, value: Long[]): void
  • Writes an array of 64-bit two's complement signed integers (Long objects).

    Parameters

    • fieldName: string

      name of the field.

    • value: Long[]

      to be written.

    Returns void

  • writeArrayOfInt8(fieldName: string, value: Buffer): void
  • Writes an array of 8-bit two's complement signed integers.

    Parameters

    • fieldName: string

      name of the field.

    • value: Buffer

      to be written.

    Returns void

  • writeArrayOfNullableBoolean(fieldName: string, value: boolean[]): void
  • Writes a nullable array of nullable booleans.

    Parameters

    • fieldName: string

      name of the field.

    • value: boolean[]

      to be written.

    Returns void

  • writeArrayOfNullableFloat32(fieldName: string, value: number[]): void
  • Writes a nullable array of nullable 32-bit IEEE 754 floating point numbers.

    Parameters

    • fieldName: string

      name of the field.

    • value: number[]

      to be written.

    Returns void

  • writeArrayOfNullableFloat64(fieldName: string, value: number[]): void
  • Writes a nullable array of nullable 64-bit IEEE 754 floating point numbers.

    Parameters

    • fieldName: string

      name of the field.

    • value: number[]

      to be written.

    Returns void

  • writeArrayOfNullableInt16(fieldName: string, value: number[]): void
  • Writes a nullable array of nullable 16-bit two's complement signed integers.

    Parameters

    • fieldName: string

      name of the field.

    • value: number[]

      to be written.

    Returns void

  • writeArrayOfNullableInt32(fieldName: string, value: number[]): void
  • Writes a nullable array of nullable 32-bit two's complement signed integers.

    Parameters

    • fieldName: string

      name of the field.

    • value: number[]

      to be written.

    Returns void

  • writeArrayOfNullableInt64(fieldName: string, value: Long[]): void
  • Writes a nullable array of nullable 64-bit two's complement signed integers (Long objects).

    Parameters

    • fieldName: string

      name of the field.

    • value: Long[]

      to be written.

    Returns void

  • writeArrayOfNullableInt8(fieldName: string, value: number[]): void
  • Writes a nullable array of nullable 8-bit two's complement signed integers.

    Parameters

    • fieldName: string

      name of the field.

    • value: number[]

      to be written.

    Returns void

  • writeArrayOfString(fieldName: string, value: string[]): void
  • Writes an array of UTF-8 encoded strings.

    Parameters

    • fieldName: string

      name of the field.

    • value: string[]

      to be written.

    Returns void

  • writeArrayOfTime(fieldName: string, value: LocalTime[]): void
  • Writes an array of LocalTime.

    Parameters

    • fieldName: string

      name of the field.

    • value: LocalTime[]

      to be written.

    Returns void

  • writeArrayOfTimestamp(fieldName: string, value: LocalDateTime[]): void
  • Writes an array of LocalDateTime.

    Parameters

    • fieldName: string

      name of the field.

    • value: LocalDateTime[]

      to be written.

    Returns void

  • writeArrayOfTimestampWithTimezone(fieldName: string, value: OffsetDateTime[]): void
  • Writes an array of OffsetDateTime.

    Parameters

    • fieldName: string

      name of the field.

    • value: OffsetDateTime[]

      to be written.

    Returns void

  • writeBoolean(fieldName: string, value: boolean): void
  • Writes a boolean.

    Parameters

    • fieldName: string

      name of the field.

    • value: boolean

      to be written.

    Returns void

  • writeCompact<T>(fieldName: string, value: T): void
  • Writes a nested compact object.

    Type parameters

    • T

    Parameters

    • fieldName: string

      name of the field.

    • value: T

      to be written.

    Returns void

  • writeDate(fieldName: string, value: LocalDate): void
  • Writes a LocalDate.

    Parameters

    • fieldName: string

      name of the field.

    • value: LocalDate

      to be written.

    Returns void

  • writeDecimal(fieldName: string, value: BigDecimal): void
  • Writes a BigDecimal

    Parameters

    • fieldName: string

      name of the field.

    • value: BigDecimal

      to be written.

    Returns void

  • writeFloat32(fieldName: string, value: number): void
  • Writes a 32-bit IEEE 754 floating point number.

    Parameters

    • fieldName: string

      name of the field.

    • value: number

      to be written.

    Returns void

  • writeFloat64(fieldName: string, value: number): void
  • Writes a 64-bit IEEE 754 floating point number.

    Parameters

    • fieldName: string

      name of the field.

    • value: number

      to be written.

    Returns void

  • writeInt16(fieldName: string, value: number): void
  • Writes a 16-bit two's complement signed integer.

    Parameters

    • fieldName: string

      name of the field.

    • value: number

      to be written.

    Returns void

  • writeInt32(fieldName: string, value: number): void
  • Writes a 32-bit two's complement signed integer.

    Parameters

    • fieldName: string

      name of the field.

    • value: number

      to be written.

    Returns void

  • writeInt64(fieldName: string, value: Long): void
  • Writes a 64-bit two's complement signed integer (a Long object).

    Parameters

    • fieldName: string

      name of the field.

    • value: Long

      to be written.

    Returns void

  • writeInt8(fieldName: string, value: number): void
  • Writes an 8-bit two's complement signed integer.

    Parameters

    • fieldName: string

      name of the field.

    • value: number

      to be written.

    Returns void

  • writeNullableBoolean(fieldName: string, value: boolean): void
  • Writes a nullable boolean.

    Parameters

    • fieldName: string

      name of the field.

    • value: boolean

      to be written.

    Returns void

  • writeNullableFloat32(fieldName: string, value: number): void
  • Writes a nullable 32-bit IEEE 754 floating point number.

    Parameters

    • fieldName: string

      name of the field.

    • value: number

      to be written.

    Returns void

  • writeNullableFloat64(fieldName: string, value: number): void
  • Writes a nullable 64-bit IEEE 754 floating point number.

    Parameters

    • fieldName: string

      name of the field.

    • value: number

      to be written.

    Returns void

  • writeNullableInt16(fieldName: string, value: number): void
  • Writes a nullable 16-bit two's complement signed integer.

    Parameters

    • fieldName: string

      name of the field.

    • value: number

      to be written.

    Returns void

  • writeNullableInt32(fieldName: string, value: number): void
  • Writes a nullable 32-bit two's complement signed integer.

    Parameters

    • fieldName: string

      name of the field.

    • value: number

      to be written.

    Returns void

  • writeNullableInt64(fieldName: string, value: Long): void
  • Writes a nullable 64-bit two's complement signed integer (a Long object).

    Parameters

    • fieldName: string

      name of the field.

    • value: Long

      to be written.

    Returns void

  • writeNullableInt8(fieldName: string, value: number): void
  • Writes a nullable 8-bit two's complement signed integer.

    Parameters

    • fieldName: string

      name of the field.

    • value: number

      to be written.

    Returns void

  • writeString(fieldName: string, value: string): void
  • Writes an UTF-8 encoded string.

    Parameters

    • fieldName: string

      name of the field.

    • value: string

      to be written.

    Returns void

  • writeTime(fieldName: string, value: LocalTime): void
  • Writes a LocalTime.

    Parameters

    • fieldName: string

      name of the field.

    • value: LocalTime

      to be written.

    Returns void

  • Writes a LocalDateTime.

    Parameters

    • fieldName: string

      name of the field.

    • value: LocalDateTime

      to be written.

    Returns void

  • writeTimestampWithTimezone(fieldName: string, value: OffsetDateTime): void
  • Reads a OffsetDateTime.

    Parameters

    • fieldName: string

      name of the field.

    • value: OffsetDateTime

      to be written.

    Returns void

Generated using TypeDoc