Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EnumSerializer<Enum>

This class is meant to help you to construct a serializer which maps a static list of values to their indexes and only serialize those. The values provided will be reduced to exclude duplications which are determined by the their identity (==).

Despite its name, this class can be used to serialize any number of static collection of items to their indexes.

Be aware that this serializer needs to be configured the same way when deserializing otherwise it will not map to the correct value.

Type parameters

  • Enum

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

arrayBufferToValue

  • arrayBufferToValue(arrayBuffer: ArrayBuffer): Enum

deserialize

  • deserialize(dv: DataView, offset: number): { offset: number; val: Enum }

fromBaseToOrigin

  • fromBaseToOrigin(val: number): Enum

fromOriginToBase

  • fromOriginToBase(val: Enum): number

getByteSizeFromDataInBuffer

  • getByteSizeFromDataInBuffer(dv: DataView, offset: number): number

getSizeForValue

  • getSizeForValue(val: Enum): number

getStaticSize

  • getStaticSize(): number | undefined

isPartOfEnum

  • isPartOfEnum(val: any): val is Enum

originTypeCheck

  • originTypeCheck(val: Enum, name: string): void

serialize

  • serialize(dv: DataView, offset: number, val: Enum): { offset: number }

typeCheck

  • typeCheck(val: Enum, name?: string): void

valueToArrayBuffer

  • valueToArrayBuffer(val: Enum): ArrayBuffer

Generated using TypeDoc