_BitStringHelperInternal

Internal functions used by the module.

Index

Constructors

• constructor

Properties

• CHAR_BITS
• CHAR_BYTES
• CHAR_MASK
• SAFE_INTEGER_BITS

Methods

• base64ToU16String
• checkBitsCountCorrect
• getMask
• twosComplementToSigned
• twosComplementToUnsigned
• u16ArrayToBase64

Constructors

constructor

• new _BitStringHelperInternal(): _BitStringHelperInternal

• Returns _BitStringHelperInternal

Properties

staticCHAR_BITS

CHAR_BITS: number = 16

staticCHAR_BYTES

CHAR_BYTES: number = 2

staticCHAR_MASK

CHAR_MASK: number = 0xffff

staticSAFE_INTEGER_BITS

SAFE_INTEGER_BITS: number = 53

Methods

staticbase64ToU16String

• base64ToU16String(b64Str: string): string

• Converts a base64 string obtained from calling _BitStringHelperInternal.u16ArrayToBase64 into a string which the BitStringReader can read.

  ---

  Parameters

  • b64Str: string

  Returns string

staticcheckBitsCountCorrect

• checkBitsCountCorrect(bits: number, funcName: string): void

• A helper checking user-provided bits range.

  @throws

  if bits is out of [0; SAFE_INTEGER_BITS] range.

  ---

  Parameters

  • bits: number

  • funcName: string

  Returns void

staticgetMask

• getMask(bits: number): number

• ---

  Parameters

  • bits: number

  Returns number

  An integer mask with bits lower bits set to 1.

statictwosComplementToSigned

• twosComplementToSigned(uval: number, bits: number): number

• ---

  Parameters

  • uval: number

    a non-negative integer

  • bits: number

  Returns number

  a signed integer from an unsigned interpretation of a bits-long twos complement integer uval.

statictwosComplementToUnsigned

• twosComplementToUnsigned(val: number, bits: number): number

• ---

  Parameters

  • val: number

    a signed integer

  • bits: number

  Returns number

  an unsigned bits-long twos complement interpretation of a given signed integer.

staticu16ArrayToBase64

• u16ArrayToBase64(array: number[]): string

• Converts a given array of unsigned 16-bit integers into a base64 string.

  ---

  Parameters

  • array: number[]

  Returns string