Class BitString

constructor

• new BitString(data, offset, length): BitString

• Constructing BitString from a buffer

  Parameters

  • data: Buffer

    data that contains the bitstring data. NOTE: We are expecting this buffer to be NOT modified
  • offset: number

    offset in bits from the start of the buffer
  • length: number

    length of the bitstring in bits

  Returns BitString

Static Readonly EMPTY

length

• get length(): number

• Returns the length of the bitstring

  Returns number

[SymbolInspect]

• [SymbolInspect](): string

• Returns string

at

• at(index): boolean

• Returns the bit at the specified index

  Parameters

  • index: number

    index of the bit

  Returns boolean

  true if the bit is set, false otherwise

  Throws

  Error if index is out of bounds

equals

• equals(b): boolean

• Checks for equality

  Parameters

  • b: BitString

    other bitstring

  Returns boolean

  true if the bitstrings are equal, false otherwise

subbuffer

• subbuffer(offset, length): null | Buffer

• Try to get a buffer from the bitstring without allocations

  Parameters

  • offset: number

    offset in bits
  • length: number

    length in bits

  Returns null | Buffer

  buffer if the bitstring is aligned to bytes, null otherwise

substring

• substring(offset, length): BitString

• Get a subscring of the bitstring

  Parameters

  • offset: number
  • length: number

  Returns BitString

toString

• toString(): string

• Format to canonical string

  Returns string

  formatted bits as a string

Static isBitString

• isBitString(src): src is BitString

• Checks if supplied object is BitString

  Parameters

  • src: unknown

    is unknow object

  Returns src is BitString

  true if object is BitString and false otherwise