Class BitString

Version

1.0.0

Since

1.0.5

Constructors

constructor

Accessors

HEX Length

Methods

AND Add AnyBit Clone Equals GetBit LeftRotate LeftShift NOT OR Reflect RightRotate RightShift SetBit SetLength Swap ToBytes ToNumber XOR toString FromBytes Initialize2d

Constructors

constructor

  • new BitString(): BitString

  • Returns BitString

  • new BitString(initialValue): BitString

  • Parameters

    • initialValue: number

    Returns BitString

  • new BitString(initialValue, type): BitString

  • Parameters

    Returns BitString

  • new BitString(initialValue): BitString

  • Parameters

    • initialValue: string

    Returns BitString

  • new BitString(initialValue, radix): BitString

  • Parameters

    • initialValue: string
    • radix: number

    Returns BitString

  • new BitString(initialValue, type): BitString

  • Parameters

    Returns BitString

Accessors

HEX

  • get HEX(): string

  • Returns string

Length

  • get Length(): number

  • Returns number

Methods

AND

Add

AnyBit

  • AnyBit(): boolean

  • Returns boolean

Clone

Equals

  • Equals(another): boolean

  • Parameters

    Returns boolean

GetBit

  • GetBit(offset, defaultVal?): boolean

  • Parameters

    • offset: number
    • defaultVal: boolean = false

    Returns boolean

    Since

    1.1.20

    Version

    2019-04-01

LeftRotate

  • LeftRotate(n, bits?): BitString

  • Parameters

    • n: number
    • bits: number = 64

    Returns BitString

LeftShift

  • LeftShift(n): BitString

  • Parameters

    • n: number

    Returns BitString

NOT

  • NOT(): BitString

  • Returns BitString

    Since

    1.1.20

    Version

    2019-04-01

OR

Reflect

  • Reflect(bits?): BitString

  • Parameters

    • Optional bits: number

    Returns BitString

RightRotate

  • RightRotate(n, bits?): BitString

  • Parameters

    • n: number
    • bits: number = 64

    Returns BitString

RightShift

  • RightShift(n): BitString

  • Parameters

    • n: number

    Returns BitString

SetBit

  • SetBit(offset, val): BitString

  • Set some bit

    Parameters

    • offset: number

      right to left, start from 1

    • val: boolean

      true or false

    Returns BitString

SetLength

  • SetLength(bits): BitString

  • Parameters

    • bits: number

    Returns BitString

Swap

  • Swap(bytes?): BitString

  • Parameters

    • bytes: number = 8

    Returns BitString

ToBytes

  • ToBytes(bits?): number[]

  • Parameters

    • Optional bits: number

    Returns number[]

ToNumber

  • ToNumber(): number

  • Returns number

XOR

toString

  • toString(type?, trim?): string

  • Parameters

    Returns string

Static FromBytes

  • FromBytes(...bytes): BitString

  • Parameters

    • Rest ...bytes: number[]

    Returns BitString

Static Initialize2d

  • Initialize2d(x, y): BitString[][]

  • Parameters

    • x: number
    • y: number

    Returns BitString[][]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc