Options
All
  • Public
  • Public/Protected
  • All
Menu

Reader helper for Portable objects.

Hierarchy

  • PortableReader

Index

Methods

  • getFieldNames(): string[]
  • getVersion(): number
  • hasField(fieldName: string): boolean
  • Parameters

    • fieldName: string

      name of the field (does not support nested paths)

    Returns boolean

    true if field exist in this class.

  • readBoolean(fieldName: string): boolean
  • readBooleanArray(fieldName: string): boolean[]
  • Reads an array of primitive booleans.

    Parameters

    • fieldName: string

      name of the field

    Returns boolean[]

    the boolean array value read

  • readByte(fieldName: string): number
  • readByteArray(fieldName: string): Buffer
  • readChar(fieldName: string): string
  • Reads a single character string using String.fromCharCode from two bytes of UTF-16 code units.

    Parameters

    • fieldName: string

      name of the field

    Returns string

    the char value read

  • readCharArray(fieldName: string): string[]
  • Reads an array of single character strings. Each of them are read using String.fromCharCode from a two bytes UTF-16 code units.

    Parameters

    • fieldName: string

      name of the field

    Returns string[]

    the char array value read

  • readDateArray(fieldName: string): LocalDate[]
  • readDouble(fieldName: string): number
  • readDoubleArray(fieldName: string): number[]
  • readFloat(fieldName: string): number
  • readFloatArray(fieldName: string): number[]
  • readInt(fieldName: string): number
  • readIntArray(fieldName: string): number[]
  • Reads an array of 32-bit signed integers.

    Parameters

    • fieldName: string

      name of the field

    Returns number[]

    the int array value read

  • readLong(fieldName: string): Long
  • readLongArray(fieldName: string): Long[]
  • readPortable(fieldName: string): Portable
  • readPortableArray(fieldName: string): Portable[]
  • readShort(fieldName: string): number
  • readShortArray(fieldName: string): number[]
  • Reads an array of 16-bit signed integers.

    Parameters

    • fieldName: string

      name of the field

    Returns number[]

    the short array value read

  • readString(fieldName: string): string
  • Reads a string from UTF-8 encoded bytes.

    Parameters

    • fieldName: string

      name of the field

    Returns string

    the string value read

  • readStringArray(fieldName: string): string[]
  • Reads an array of strings. Strings are read using UTF-8 encoding.

    Parameters

    • fieldName: string

      name of the field

    Returns string[]

    the string array value read

  • readTimeArray(fieldName: string): LocalTime[]
  • readUTF(fieldName: string): string
  • Reads a string from UTF-8 encoded bytes.

    deprecated

    since version 4.2 for the sake of better naming. Please use readString instead.

    Parameters

    • fieldName: string

      name of the field

    Returns string

    the UTF string value read

  • readUTFArray(fieldName: string): string[]
  • Reads an array strings. Strings are read using UTF-8 encoding.

    deprecated

    since version 4.2 for the sake of better naming. Please use readStringArray instead

    Parameters

    • fieldName: string

      name of the field

    Returns string[]

    the string array value read

Generated using TypeDoc