Interface CompactWriter

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

Methods

writeArrayOfBoolean

writeArrayOfBoolean(fieldName: string, value: boolean[]): void

- Defined in src/serialization/compact/CompactWriter.ts:144
Writes an array of booleans.

Parameters
- fieldName: string
  
  name of the field.
- value: boolean[]
  
  to be written.
Returns void

writeArrayOfCompact

writeArrayOfCompact<T>(fieldName: string, value: T[]): void

- Defined in src/serialization/compact/CompactWriter.ts:248
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

writeArrayOfDate(fieldName: string, value: LocalDate[]): void

- Defined in src/serialization/compact/CompactWriter.ts:224
Writes an array of LocalDate.

Parameters
- fieldName: string
  
  name of the field.
- value: LocalDate[]
  
  to be written.
Returns void

writeArrayOfDecimal

writeArrayOfDecimal(fieldName: string, value: BigDecimal[]): void

- Defined in src/serialization/compact/CompactWriter.ts:208
Writes an array of BigDecimal.

Parameters
- fieldName: string
  
  name of the field.
- value: BigDecimal[]
  
  to be written.
Returns void

writeArrayOfFloat32

writeArrayOfFloat32(fieldName: string, value: number[]): void

- Defined in src/serialization/compact/CompactWriter.ts:184
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

writeArrayOfFloat64(fieldName: string, value: number[]): void

- Defined in src/serialization/compact/CompactWriter.ts:192
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

writeArrayOfInt16(fieldName: string, value: number[]): void

- Defined in src/serialization/compact/CompactWriter.ts:160
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

writeArrayOfInt32(fieldName: string, value: number[]): void

- Defined in src/serialization/compact/CompactWriter.ts:168
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

writeArrayOfInt64(fieldName: string, value: Long[]): void

- Defined in src/serialization/compact/CompactWriter.ts:176
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

writeArrayOfInt8(fieldName: string, value: Buffer): void

- Defined in src/serialization/compact/CompactWriter.ts:152
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

writeArrayOfNullableBoolean(fieldName: string, value: boolean[]): void

- Defined in src/serialization/compact/CompactWriter.ts:312
Writes a nullable array of nullable booleans.

Parameters
- fieldName: string
  
  name of the field.
- value: boolean[]
  
  to be written.
Returns void

writeArrayOfNullableFloat32

writeArrayOfNullableFloat32(fieldName: string, value: number[]): void

- Defined in src/serialization/compact/CompactWriter.ts:352
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

writeArrayOfNullableFloat64(fieldName: string, value: number[]): void

- Defined in src/serialization/compact/CompactWriter.ts:360
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

writeArrayOfNullableInt16(fieldName: string, value: number[]): void

- Defined in src/serialization/compact/CompactWriter.ts:328
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

writeArrayOfNullableInt32(fieldName: string, value: number[]): void

- Defined in src/serialization/compact/CompactWriter.ts:336
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

writeArrayOfNullableInt64(fieldName: string, value: Long[]): void

- Defined in src/serialization/compact/CompactWriter.ts:344
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

writeArrayOfNullableInt8(fieldName: string, value: number[]): void

- Defined in src/serialization/compact/CompactWriter.ts:320
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

writeArrayOfString(fieldName: string, value: string[]): void

- Defined in src/serialization/compact/CompactWriter.ts:200
Writes an array of UTF-8 encoded strings.

Parameters
- fieldName: string
  
  name of the field.
- value: string[]
  
  to be written.
Returns void

writeArrayOfTime

writeArrayOfTime(fieldName: string, value: LocalTime[]): void

- Defined in src/serialization/compact/CompactWriter.ts:216
Writes an array of LocalTime.

Parameters
- fieldName: string
  
  name of the field.
- value: LocalTime[]
  
  to be written.
Returns void

writeArrayOfTimestamp

writeArrayOfTimestamp(fieldName: string, value: LocalDateTime[]): void

- Defined in src/serialization/compact/CompactWriter.ts:232
Writes an array of LocalDateTime.

Parameters
- fieldName: string
  
  name of the field.
- value: LocalDateTime[]
  
  to be written.
Returns void

writeArrayOfTimestampWithTimezone

writeArrayOfTimestampWithTimezone(fieldName: string, value: OffsetDateTime[]): void

- Defined in src/serialization/compact/CompactWriter.ts:240
Writes an array of OffsetDateTime.

Parameters
- fieldName: string
  
  name of the field.
- value: OffsetDateTime[]
  
  to be written.
Returns void

writeBoolean

writeBoolean(fieldName: string, value: boolean): void

- Defined in src/serialization/compact/CompactWriter.ts:32
Writes a boolean.

Parameters
- fieldName: string
  
  name of the field.
- value: boolean
  
  to be written.
Returns void

writeCompact

writeCompact<T>(fieldName: string, value: T): void

- Defined in src/serialization/compact/CompactWriter.ts:136
Writes a nested compact object.

Type parameters
- T
Parameters
- fieldName: string
  
  name of the field.
- value: T
  
  to be written.
Returns void

writeDate

writeDate(fieldName: string, value: LocalDate): void

- Defined in src/serialization/compact/CompactWriter.ts:112
Writes a LocalDate.

Parameters
- fieldName: string
  
  name of the field.
- value: LocalDate
  
  to be written.
Returns void

writeDecimal

writeDecimal(fieldName: string, value: BigDecimal): void

- Defined in src/serialization/compact/CompactWriter.ts:96
Writes a BigDecimal

Parameters
- fieldName: string
  
  name of the field.
- value: BigDecimal
  
  to be written.
Returns void

writeFloat32

writeFloat32(fieldName: string, value: number): void

- Defined in src/serialization/compact/CompactWriter.ts:72
Writes a 32-bit IEEE 754 floating point number.

Parameters
- fieldName: string
  
  name of the field.
- value: number
  
  to be written.
Returns void

writeFloat64

writeFloat64(fieldName: string, value: number): void

- Defined in src/serialization/compact/CompactWriter.ts:80
Writes a 64-bit IEEE 754 floating point number.

Parameters
- fieldName: string
  
  name of the field.
- value: number
  
  to be written.
Returns void

writeInt16

writeInt16(fieldName: string, value: number): void

- Defined in src/serialization/compact/CompactWriter.ts:48
Writes a 16-bit two's complement signed integer.

Parameters
- fieldName: string
  
  name of the field.
- value: number
  
  to be written.
Returns void

writeInt32

writeInt32(fieldName: string, value: number): void

- Defined in src/serialization/compact/CompactWriter.ts:56
Writes a 32-bit two's complement signed integer.

Parameters
- fieldName: string
  
  name of the field.
- value: number
  
  to be written.
Returns void

writeInt64

writeInt64(fieldName: string, value: Long): void

- Defined in src/serialization/compact/CompactWriter.ts:64
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

writeInt8(fieldName: string, value: number): void

- Defined in src/serialization/compact/CompactWriter.ts:40
Writes an 8-bit two's complement signed integer.

Parameters
- fieldName: string
  
  name of the field.
- value: number
  
  to be written.
Returns void

writeNullableBoolean

writeNullableBoolean(fieldName: string, value: boolean): void

- Defined in src/serialization/compact/CompactWriter.ts:256
Writes a nullable boolean.

Parameters
- fieldName: string
  
  name of the field.
- value: boolean
  
  to be written.
Returns void

writeNullableFloat32

writeNullableFloat32(fieldName: string, value: number): void

- Defined in src/serialization/compact/CompactWriter.ts:296
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

writeNullableFloat64(fieldName: string, value: number): void

- Defined in src/serialization/compact/CompactWriter.ts:304
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

writeNullableInt16(fieldName: string, value: number): void

- Defined in src/serialization/compact/CompactWriter.ts:272
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

writeNullableInt32(fieldName: string, value: number): void

- Defined in src/serialization/compact/CompactWriter.ts:280
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

writeNullableInt64(fieldName: string, value: Long): void

- Defined in src/serialization/compact/CompactWriter.ts:288
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

writeNullableInt8(fieldName: string, value: number): void

- Defined in src/serialization/compact/CompactWriter.ts:264
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

writeString(fieldName: string, value: string): void

- Defined in src/serialization/compact/CompactWriter.ts:88
Writes an UTF-8 encoded string.

Parameters
- fieldName: string
  
  name of the field.
- value: string
  
  to be written.
Returns void

writeTime

writeTime(fieldName: string, value: LocalTime): void

- Defined in src/serialization/compact/CompactWriter.ts:104
Writes a LocalTime.

Parameters
- fieldName: string
  
  name of the field.
- value: LocalTime
  
  to be written.
Returns void

writeTimestamp

writeTimestamp(fieldName: string, value: LocalDateTime): void

- Defined in src/serialization/compact/CompactWriter.ts:120
Writes a LocalDateTime.

Parameters
- fieldName: string
  
  name of the field.
- value: LocalDateTime
  
  to be written.
Returns void

writeTimestampWithTimezone

writeTimestampWithTimezone(fieldName: string, value: OffsetDateTime): void

- Defined in src/serialization/compact/CompactWriter.ts:128
Reads a OffsetDateTime.

Parameters
- fieldName: string
  
  name of the field.
- value: OffsetDateTime
  
  to be written.
Returns void

Generated using TypeDoc