Class BitString

BitString is a class that represents a bitstring in a buffer with a specified offset and length

Hierarchy

BitString

Index

Constructors

Properties

_data _length _offset EMPTY

Accessors

Methods

[SymbolInspect] at equals subbuffer substring toString isBitString

Constructors

constructor

new BitString(data: Buffer, offset: number, length: number): 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
- Defined in src/boc/BitString.ts:41

Properties

`Private` `Readonly` _data

_data: Buffer

`Private` `Readonly` _length

_length: number

`Private` `Readonly` _offset

_offset: number

`Static` `Readonly` EMPTY

EMPTY: BitString = ...

Accessors

length

get length(): number
Returns the length of the bitstring

Returns number
- Defined in src/boc/BitString.ts:56

Methods

[SymbolInspect]

[SymbolInspect](): string
Returns string
- Defined in src/boc/BitString.ts:186

at

at(index: number): boolean
Returns the bit at the specified index

Throws
Error if index is out of bounds

Returns
true if the bit is set, false otherwise
Parameters
- index: number
  
  index of the bit
Returns boolean
- Defined in src/boc/BitString.ts:66

equals

equals(b: BitString): boolean
Checks for equality

Returns
true if the bitstrings are equal, false otherwise
Parameters
- b: BitString
  
  other bitstring
Returns boolean
- Defined in src/boc/BitString.ts:151

subbuffer

subbuffer(offset: number, length: number): null | Buffer
Try to get a buffer from the bitstring without allocations

Returns
buffer if the bitstring is aligned to bytes, null otherwise
Parameters
- offset: number
  
  offset in bits
- length: number
  
  length in bits
Returns null | Buffer
- Defined in src/boc/BitString.ts:119

substring

substring(offset: number, length: number): BitString
Get a subscring of the bitstring

Returns
Parameters
- offset: number
- length: number
Returns BitString
- Defined in src/boc/BitString.ts:90

toString

toString(): string
Format to canonical string

Returns
formatted bits as a string

Returns string
- Defined in src/boc/BitString.ts:167

`Static` isBitString

isBitString(src: unknown): src is BitString
Checks if supplied object is BitString

Returns
true if object is BitString and false otherwise
Parameters
- src: unknown
  
  is unknow object
Returns src is BitString
- Defined in src/boc/BitString.ts:32

Generated using TypeDoc