Class BitString

Version

1.0.0

Since

1.0.5

Hierarchy

BitString

Index

Constructors

Accessors

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
- Defined in libs/BitString.ts:66
new BitString(initialValue: number): BitString
Parameters
- initialValue: number
Returns BitString
- Defined in libs/BitString.ts:67
new BitString(initialValue: number, type: BitStringType): BitString
Parameters
- initialValue: number
- type: BitStringType
Returns BitString
- Defined in libs/BitString.ts:68
new BitString(initialValue: string): BitString
Parameters
- initialValue: string
Returns BitString
- Defined in libs/BitString.ts:69
new BitString(initialValue: string, radix: number): BitString
Parameters
- initialValue: string
- radix: number
Returns BitString
- Defined in libs/BitString.ts:70
new BitString(initialValue: string, type: BitStringType): BitString
Parameters
- initialValue: string
- type: BitStringType
Returns BitString
- Defined in libs/BitString.ts:71

Accessors

HEX

get HEX(): string
Returns string
- Defined in libs/BitString.ts:47

Length

get Length(): number
Returns number
- Defined in libs/BitString.ts:43

Methods

AND

AND(val: number | BitString): BitString
Since
1.1.20

Version
2019-04-01
Parameters
- val: number | BitString
Returns BitString
- Defined in libs/BitString.ts:249

Add

Add(val: BitString): BitString
Since
1.1.20

Version
2019-04-01
Parameters
- val: BitString
Returns BitString
- Defined in libs/BitString.ts:208

AnyBit

AnyBit(): boolean
Returns boolean
- Defined in libs/BitString.ts:169

Clone

Clone(): BitString
Returns BitString
- Defined in libs/BitString.ts:406

Equals

Equals(another: BitString): boolean
Parameters
- another: BitString
Returns boolean
- Defined in libs/BitString.ts:418

GetBit

GetBit(offset: number, defaultVal?: boolean): boolean
Since
1.1.20

Version
2019-04-01
Parameters
- offset: number
- defaultVal: boolean = false
Returns boolean
- Defined in libs/BitString.ts:156

LeftRotate

LeftRotate(n: number, bits?: number): BitString
Parameters
- n: number
- bits: number = 64
Returns BitString
- Defined in libs/BitString.ts:355

LeftShift

LeftShift(n: number): BitString
Parameters
- n: number
Returns BitString
- Defined in libs/BitString.ts:340

NOT

NOT(): BitString
Since
1.1.20

Version
2019-04-01

Returns BitString
- Defined in libs/BitString.ts:304

OR

OR(val: number | BitString): BitString
Since
1.1.20

Version
2019-04-01
Parameters
- val: number | BitString
Returns BitString
- Defined in libs/BitString.ts:275

Reflect

Reflect(bits?: number): BitString
Parameters
- Optional bits: number
Returns BitString
- Defined in libs/BitString.ts:388

RightRotate

RightRotate(n: number, bits?: number): BitString
Parameters
- n: number
- bits: number = 64
Returns BitString
- Defined in libs/BitString.ts:362

RightShift

RightShift(n: number): BitString
Parameters
- n: number
Returns BitString
- Defined in libs/BitString.ts:346

SetBit

SetBit(offset: number, val: boolean): BitString
Set some bit
Parameters
- offset: number
  
  right to left, start from 1
- val: boolean
  
  true or false
Returns BitString
- Defined in libs/BitString.ts:132

SetLength

SetLength(bits: number): BitString
Parameters
- bits: number
Returns BitString
- Defined in libs/BitString.ts:396

Swap

Swap(bytes?: number): BitString
Parameters
- bytes: number = 8
Returns BitString
- Defined in libs/BitString.ts:410

ToBytes

ToBytes(bits?: number): number[]
Parameters
- Optional bits: number
Returns number[]
- Defined in libs/BitString.ts:373

ToNumber

ToNumber(): number
Returns number
- Defined in libs/BitString.ts:369

XOR

XOR(val: number | BitString): BitString
Since
1.1.20

Version
2019-04-01
Parameters
- val: number | BitString
Returns BitString
- Defined in libs/BitString.ts:320

toString

toString(type?: BitStringType, trim?: boolean): string
Parameters
- type: BitStringType = BitStringType.HEX
- trim: boolean = false
Returns string
- Defined in libs/BitString.ts:173

`Static` FromBytes

FromBytes(...bytes: number[]): BitString
Parameters
- Rest ...bytes: number[]
Returns BitString
- Defined in libs/BitString.ts:51

`Static` Initialize2d

Initialize2d(x: number, y: number): BitString[][]
Parameters
- x: number
- y: number
Returns BitString[][]
- Defined in libs/BitString.ts:60

Generated using TypeDoc