Writer helper for Portable objects.

Hierarchy

  • PortableWriter

Methods

  • Writes a primitive boolean.

    Parameters

    • fieldName: string

      name of the field

    • value: boolean

      boolean value to be written

    Returns void

  • Writes an array of primitive booleans.

    Parameters

    • fieldName: string

      name of the field

    • booleans: boolean[]

      boolean array to be written

    Returns void

  • Writes a number as 8-bit unsigned integer.

    Parameters

    • fieldName: string

      name of the field

    • value: number

      byte value to be written. Must be a valid unsigned 8-bit integer. Behaviour is undefined when value is anything other than a unsigned 8-bit integer.

    Returns void

  • Writes a Buffer as byte array.

    Parameters

    • fieldName: string

      name of the field

    • bytes: Buffer

      Buffer to be written

    Returns void

  • Writes a single character string using char.charCodeAt(0).

    A two-byte unsigned integer representing the UTF-16 code unit value of the single character string will be written.

    Parameters

    • fieldName: string

      name of the field

    • value: string

      char value to be written

    Returns void

  • Writes an array of single character strings using char.charCodeAt(0).

    For each single character string, a two-byte unsigned integer representing the UTF-16 code unit value will be written.

    Parameters

    • fieldName: string

      name of the field

    • chars: string[]

      char array to be written

    Returns void

  • Writes a number as double.

    Parameters

    • fieldName: string

      name of the field

    • value: number

      double value to be written. The value must be a JavaScript number. Behavior is undefined when value is anything other than a JavaScript number.

    Returns void

  • Writes an array of numbers as doubles.

    Parameters

    • fieldName: string

      name of the field

    • values: number[]

      double array to be written. Each value must be a JavaScript number. Behavior is undefined when any value is anything other than a JavaScript number.

    Returns void

  • Writes a number as float.

    Parameters

    • fieldName: string

      name of the field

    • value: number

      float value to be written. The value must be a JavaScript number. Behavior is undefined when value is anything other than a JavaScript number.

    Returns void

  • Writes an array of numbers as floats.

    Parameters

    • fieldName: string

      name of the field

    • values: number[]

      float array to be written. Each value must be a JavaScript number. Behavior is undefined when any value is anything other than a JavaScript number.

    Returns void

  • Writes a number as 32-bit signed integer.

    Parameters

    • fieldName: string

      name of the field

    • value: number

      int value to be written. The value must be a valid signed 32-bit integer. Behavior is undefined when value is anything other than a signed 32-bit integer.

    Returns void

  • Writes an array of numbers as 32-bit signed integer array.

    Parameters

    • fieldName: string

      name of the field

    • ints: number[]

      int array to be written. Each value must be a valid signed 32-bit integer. Behavior is undefined when any value is anything other than a signed 32-bit integer.

    Returns void

  • Writes a long.

    Parameters

    • fieldName: string

      name of the field

    • value: Long

      long value to be written

    Returns void

  • Writes an array of longs.

    Parameters

    • fieldName: string

      name of the field

    • longs: Long[]

      long array to be written

    Returns void

  • To write a null Portable value, you need to provide class and factory IDs of the related class.

    Parameters

    • fieldName: string

      name of the field

    • factoryId: number

      factory ID of related Portable class

    • classId: number

      class ID of related Portable class

    Returns void

  • Writes a number as 16-bit signed integer.

    Parameters

    • fieldName: string

      name of the field

    • value: number

      short value to be written. The value must be a valid signed 16-bit integer. Behavior is undefined when value is anything other than an signed 16-bit integer.

    Returns void

  • Writes an array of numbers as 16-bit signed integers.

    Parameters

    • fieldName: string

      name of the field

    • values: number[]

      short array to be written. Each value must be a valid signed 16-bit integer. Behavior is undefined when any value is anything other than a signed 16-bit integer.

    Returns void

  • Writes a string as UTF-8 encoded bytes.

    Parameters

    • fieldName: string

      name of the field

    • value: string

      UTF string value to be written

    Returns void

  • Writes an array of strings. Each string is written as UTF-8 encoded bytes.

    Parameters

    • fieldName: string

      name of the field

    • values: string[]

      string array to be written

    Returns void

  • Writes a string as UTF-8 encoded bytes.

    Deprecated

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

    Parameters

    • fieldName: string

      name of the field

    • value: string

      UTF string value to be written

    Returns void

  • Writes an array of strings. Each string is written as UTF-8 encoded bytes.

    Deprecated

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

    Parameters

    • fieldName: string

      name of the field

    • values: string[]

      string array to be written

    Returns void

Generated using TypeDoc