Class Encoder

constructor

• new Encoder(encoders?, defaultEncoder?): Encoder

• Parameters

  • Optionalencoders: Map<string, EncodeFunc>
  • OptionaldefaultEncoder: EncodeFunc

  Returns Encoder

OptionaldefaultEncoder

Optionalencoders

encodeDefault

• encodeDefault(value, strict?): Uint8Array

• Parameters

  • value: unknown
  • strict: boolean = false

  Returns Uint8Array

encodeDefaultConstantTime

• encodeDefaultConstantTime(value, strict?): Uint8Array

• Parameters

  • value: unknown
  • strict: boolean = false

  Returns Uint8Array

encodeMessage

• encodeMessage(name, value, strict?): Uint8Array

• Encode a message with given name and value. Will throw an error if no appropriate encoder found.

  Parameters

  • name: string
  • value: unknown
  • strict: boolean = false

    If set to false and no appropriate encoder is found but the value is a bytearray, it will encode it using the built-in mechanism

  Returns Uint8Array

encodeMessageConstantTime

• encodeMessageConstantTime(name, value, strict?): Uint8Array

• Encode a message with given name and value. Will throw an error if no appropriate encoder found.

  Parameters

  • name: string
  • value: unknown
  • strict: boolean = false

    If set to false and no appropriate encoder is found but the value is a bytearray, it will encode it using the built-in mechanism

  Returns Uint8Array

encodeMessageObject

• encodeMessageObject(messages, strict?): [string[], Uint8Array[]]

• Encode messages given as JS object. It flattens the object into a sorted list and encodes each value as per the known encoding functions. Returns 2 arrays, 1st with message names and 2nd with encoded values.

  Parameters

  • messages: object
  • strict: boolean = false

    If set to false and no appropriate encoder is found but the value is a bytearray, it will encode it using the built-in mechanism

  Returns [string[], Uint8Array[]]

encodeMessageObjectAsMap

• encodeMessageObjectAsMap(messages, strict?): Map<string, Uint8Array>

• Encode messages given as JS object. It flattens the object into a sorted list and encodes each value as per the known encoding functions. Returns a Map with names as keys and encoded messages as values.

  Parameters

  • messages: object
  • strict: boolean = false

    If set to false and no appropriate encoder is found but the value is a bytearray, it will encode it using the built-in mechanism

  Returns Map<string, Uint8Array>

encodeMessageObjectAsMapConstantTime

• encodeMessageObjectAsMapConstantTime(messages, strict?): Map<string, Uint8Array>

• Encode messages given as JS object. It flattens the object into a sorted list and encodes each value as per the known encoding functions. Returns a Map with names as keys and encoded messages as values.

  Parameters

  • messages: object
  • strict: boolean = false

    If set to false and no appropriate encoder is found but the value is a bytearray, it will encode it using the built-in mechanism

  Returns Map<string, Uint8Array>

encodeMessageObjectAsObject

• encodeMessageObjectAsObject(messages, strict?): {
      [name: string]: Uint8Array;
  }

• Encode messages given as JS object. It flattens the object into a sorted list and encodes each value as per the known encoding functions. Returns an object with names as keys and encoded messages as values.

  Parameters

  • messages: object
  • strict: boolean = false

    If set to false and no appropriate encoder is found but the value is a bytearray, it will encode it using the built-in mechanism

  Returns {
      [name: string]: Uint8Array;
  }

  • [name: string]: Uint8Array

encodeMessageObjectAsObjectConstantTime

• encodeMessageObjectAsObjectConstantTime(messages, strict?): {
      [name: string]: Uint8Array;
  }

• Encode messages given as JS object. It flattens the object into a sorted list and encodes each value as per the known encoding functions. Returns an object with names as keys and encoded messages as values.

  Parameters

  • messages: object
  • strict: boolean = false

    If set to false and no appropriate encoder is found but the value is a bytearray, it will encode it using the built-in mechanism

  Returns {
      [name: string]: Uint8Array;
  }

  • [name: string]: Uint8Array

encodeMessageObjectConstantTime

• encodeMessageObjectConstantTime(messages, strict?): [string[], Uint8Array[]]

• Encode messages given as JS object. It flattens the object into a sorted list and encodes each value as per the known encoding functions. Returns 2 arrays, 1st with message names and 2nd with encoded values.

  Parameters

  • messages: object
  • strict: boolean = false

    If set to false and no appropriate encoder is found but the value is a bytearray, it will encode it using the built-in mechanism

  Returns [string[], Uint8Array[]]

StaticbooleanEncoder

• booleanEncoder(): EncodeFunc

• Returns an encoding function to be used on a message that is a boolean, encoded as positive int (0 or 1)

  Returns EncodeFunc

StaticdateEncoder

• dateEncoder(minimum): EncodeFunc

• Returns an encoding function to be used on a message that is a date

  Parameters

  • minimum: number

  Returns EncodeFunc

StaticdecimalNumberEncoder

• decimalNumberEncoder(minimum, maxDecimalPlaces): EncodeFunc

• Returns an encoding function to be used on a message that can be a positive, negative or decimal number, eg. -2.35

  Parameters

  • minimum: number

    The minimum negative value that the message can take
  • maxDecimalPlaces: number

    The maximum decimal places

  Returns EncodeFunc

StaticdecimalNumberToPositiveInt

• decimalNumberToPositiveInt(minimum, maxDecimalPlaces): ToPositiveIntFunc

• Returns a function that can convert any number to a positive integer when its minimum negative value and maximum decimal places are known. Does that by adding an offset of abs(minimum) and then multiplying it by 10^max_decimal_places

  Parameters

  • minimum: number
  • maxDecimalPlaces: number

  Returns ToPositiveIntFunc

StaticdefaultEncodeFunc

• defaultEncodeFunc(): EncodeFunc

• Returns an encoding function to convert utf-8 string message. It might fail if the encoding target cannot be made a string

  Returns EncodeFunc

StaticdefaultEncodeFuncConstantTime

• defaultEncodeFuncConstantTime(): EncodeFunc

• Returns an encoding function to convert utf-8 string message. It might fail if the encoding target cannot be made a string

  Returns EncodeFunc

StaticintegerEncoder

• integerEncoder(minimum): EncodeFunc

• Returns an encoding function to be used on a message that can be a positive or negative integer.

  Parameters

  • minimum: number

    The minimum negative value that the message can take

  Returns EncodeFunc

StaticintegerToPositiveInt

• integerToPositiveInt(minimum): ToPositiveIntFunc

• Returns a function that can convert any input integer to a positive integer when its minimum negative value is known. Does that by adding an offset of abs(minimum) to the input

  Parameters

  • minimum: number

  Returns ToPositiveIntFunc

StaticpositiveDecimalNumberEncoder

• positiveDecimalNumberEncoder(maxDecimalPlaces): EncodeFunc

• Returns an encoding function to be used on a message that can be a positive decimal number, eg. 2.7

  Parameters

  • maxDecimalPlaces: number

    The maximum decimal places

  Returns EncodeFunc

StaticpositiveDecimalNumberToPositiveInt

• positiveDecimalNumberToPositiveInt(maxDecimalPlaces): ToPositiveIntFunc

• Returns a function that can convert any positive number to a positive integer when its maximum decimal places are known. Does that by multiplying it by 10^max_decimal_places, eg. 23.452 -> 23452

  Parameters

  • maxDecimalPlaces: number

  Returns ToPositiveIntFunc

StaticpositiveIntegerEncoder

• positiveIntegerEncoder(): EncodeFunc

• Returns an encoding function to be used on a message that is a positive integer.

  Returns EncodeFunc

StaticreversibleEncoderString

• reversibleEncoderString(compress?): EncodeFunc

• Returns a reversible encoding function to be used on a string message. The output can of the EncodeFunc can be reversed.

  Parameters

  • compress: boolean = false

  Returns EncodeFunc