/ fm / liveswitch / DataBuffer

Class: DataBuffer

fm.liveswitch.DataBuffer

Binary data buffer implementation

Hierarchy

• DataBuffer

  ↳ DataBufferSubset

Table of contents

Constructors

• constructor

Methods

• and
• append
• canResize
• clone
• copy
• fmliveswitchDataBufferInit
• free
• getData
• getIndex
• getInnerData
• getIsPooled
• getIsSubset
• getLength
• getLittleEndian
• getTypeString
• keep
• or
• prepend
• read1
• read10
• read10Signed
• read11
• read11Signed
• read12
• read12Signed
• read13
• read13Signed
• read14
• read14Signed
• read15
• read15Signed
• read16
• read16Signed
• read17
• read17Signed
• read18
• read18Signed
• read19
• read19Signed
• read2
• read20
• read20Signed
• read21
• read21Signed
• read22
• read22Signed
• read23
• read23Signed
• read24
• read24Signed
• read2Signed
• read3
• read32
• read32Signed
• read3Signed
• read4
• read40
• read40Signed
• read48
• read48Signed
• read4Signed
• read5
• read56
• read56Signed
• read5Signed
• read6
• read64
• read64Signed
• read6Signed
• read7
• read7Signed
• read8
• read8Signed
• read9
• read9Signed
• readUtf8String
• resize
• sequenceEquals
• sequenceEqualsConstantTime
• set
• setInnerData
• setLittleEndian
• subset
• toArray
• toBytes
• toHexString
• toJson
• tryKeep
• tryRead1
• tryRead10
• tryRead11
• tryRead12
• tryRead13
• tryRead14
• tryRead15
• tryRead16
• tryRead17
• tryRead18
• tryRead19
• tryRead2
• tryRead20
• tryRead21
• tryRead22
• tryRead23
• tryRead24
• tryRead3
• tryRead32
• tryRead4
• tryRead40
• tryRead48
• tryRead5
• tryRead56
• tryRead6
• tryRead64
• tryRead7
• tryRead8
• tryRead9
• write
• write1
• write10
• write11
• write12
• write13
• write14
• write15
• write16
• write17
• write18
• write19
• write2
• write20
• write21
• write22
• write23
• write24
• write3
• write32
• write4
• write40
• write48
• write5
• write56
• write6
• write64
• write7
• write8
• write9
• writeBytes
• xor
• allocate
• areEqual
• fromBytes
• fromHexString
• fromJson
• fromJsonArray
• getEmpty
• toJson
• toJsonArray
• wrap

Constructors

constructor

+ new DataBuffer(): DataBuffer

Returns: DataBuffer

+ new DataBuffer(data: Uint8Array, index: number, length: number, littleEndian: boolean): DataBuffer

Parameters:

Name	Type
data	Uint8Array
index	number
length	number
littleEndian	boolean

Returns: DataBuffer

Methods

and

▸ and(value: number, offset: number): boolean

Performs a bitwise "and" operation on a value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.

Returns: boolean

---

append

▸ append(buffer: DataBuffer): DataBuffer

Appends a buffer.

Parameters:

Name	Type	Description
buffer	DataBuffer	The buffer.

Returns: DataBuffer

▸ append(buffers: DataBuffer[]): DataBuffer

Appends some buffers.

Parameters:

Name	Type	Description
buffers	DataBuffer[]	The buffers.

Returns: DataBuffer

---

canResize

▸ canResize(newLength: number, offset: number): boolean

Gets whether this buffer can be resized to the new length.

Parameters:

Name	Type	Description
newLength	number	The new length.
offset	number	The offset.

Returns: boolean

---

clone

▸ clone(): DataBuffer

Clones this instance.

Returns: DataBuffer

▸ clone(littleEndian: boolean): DataBuffer

Clones this instance.

Parameters:

Name	Type	Description
littleEndian	boolean	Whether to clone into a little endian buffer.

Returns: DataBuffer

---

copy

▸ copy(): DataBuffer

Copies this instance into new memory.

Returns: DataBuffer

▸ copy(usePool: boolean): DataBuffer

Copies this instance.

Parameters:

Name	Type
usePool	boolean

Returns: DataBuffer

---

fmliveswitchDataBufferInit

▸ PrivatefmliveswitchDataBufferInit(): void

Returns: void

---

free

▸ free(): DataBuffer

Decrements the retain count by one and returns the Buffer to the pool if zero.

Returns: DataBuffer

---

getData

▸ getData(): Uint8Array

Gets the data.

Returns: Uint8Array

---

getIndex

▸ getIndex(): number

Gets the index.

Returns: number

---

getInnerData

▸ ProtectedgetInnerData(): Uint8Array

Gets backing data buffer.

Returns: Uint8Array

---

getIsPooled

▸ getIsPooled(): boolean

Gets whether this DataBuffer is from a pool.

Returns: boolean

---

getIsSubset

▸ getIsSubset(): boolean

Gets whether this DataBuffer is a subset.

Returns: boolean

---

getLength

▸ getLength(): number

Gets the length.

Returns: number

---

getLittleEndian

▸ getLittleEndian(): boolean

Gets whether [[fm.liveswitch.dataBuffer.data]] is little-endian.

Returns: boolean

---

getTypeString

▸ getTypeString(): string

Returns: string

---

keep

▸ keep(): DataBuffer

Increment the retain count by one.

Returns: DataBuffer

---

or

▸ or(value: number, offset: number): boolean

Performs a bitwise "or" operation on a value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.

Returns: boolean

---

prepend

▸ prepend(buffer: DataBuffer): DataBuffer

Prepends a buffer.

Parameters:

Name	Type	Description
buffer	DataBuffer	The buffer.

Returns: DataBuffer

▸ prepend(buffers: DataBuffer[]): void

Prepends some buffers.

Parameters:

Name	Type	Description
buffers	DataBuffer[]	The buffers.

Returns: void

---

read1

▸ read1(offset: number, bitOffset: number): boolean

Reads a 1-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: boolean

---

read10

▸ read10(offset: number, bitOffset: number): number

Reads a 10-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bitoffset.

Returns: number

---

read10Signed

▸ read10Signed(offset: number, bitOffset: number): number

Reads a 10-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read11

▸ read11(offset: number, bitOffset: number): number

Reads a 11-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bitoffset.

Returns: number

---

read11Signed

▸ read11Signed(offset: number, bitOffset: number): number

Reads a 11-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read12

▸ read12(offset: number, bitOffset: number): number

Reads a 12-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bitoffset.

Returns: number

---

read12Signed

▸ read12Signed(offset: number, bitOffset: number): number

Reads a 12-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read13

▸ read13(offset: number, bitOffset: number): number

Reads a 13-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bitoffset.

Returns: number

---

read13Signed

▸ read13Signed(offset: number, bitOffset: number): number

Reads a 13-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read14

▸ read14(offset: number, bitOffset: number): number

Reads a 14-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read14Signed

▸ read14Signed(offset: number, bitOffset: number): number

Reads a 14-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read15

▸ read15(offset: number, bitOffset: number): number

Reads a 15-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read15Signed

▸ read15Signed(offset: number, bitOffset: number): number

Reads a 15-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read16

▸ read16(offset: number): number

Reads a 16-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.

Returns: number

▸ read16(offset: number, offsetPlus: Holder<number>): number

Reads a 16-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
offsetPlus	Holder<number>	The offset plus the value length.

Returns: number

---

read16Signed

▸ read16Signed(offset: number): number

Reads a 16-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.

Returns: number

▸ read16Signed(offset: number, offsetPlus: Holder<number>): number

Reads a 16-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
offsetPlus	Holder<number>	The offset plus the value length.

Returns: number

---

read17

▸ read17(offset: number, bitOffset: number): number

Reads a 17-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read17Signed

▸ read17Signed(offset: number, bitOffset: number): number

Reads a 17-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read18

▸ read18(offset: number, bitOffset: number): number

Reads an 18-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read18Signed

▸ read18Signed(offset: number, bitOffset: number): number

Reads an 18-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read19

▸ read19(offset: number, bitOffset: number): number

Reads a 19-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read19Signed

▸ read19Signed(offset: number, bitOffset: number): number

Reads a 19-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read2

▸ read2(offset: number, bitOffset: number): number

Reads a 2-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read20

▸ read20(offset: number, bitOffset: number): number

Reads a 20-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read20Signed

▸ read20Signed(offset: number, bitOffset: number): number

Reads a 20-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read21

▸ read21(offset: number, bitOffset: number): number

Reads a 21-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read21Signed

▸ read21Signed(offset: number, bitOffset: number): number

Reads a 21-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read22

▸ read22(offset: number, bitOffset: number): number

Reads a 22-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read22Signed

▸ read22Signed(offset: number, bitOffset: number): number

Reads a 22-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read23

▸ read23(offset: number, bitOffset: number): number

Reads a 23-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read23Signed

▸ read23Signed(offset: number, bitOffset: number): number

Reads a 23-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read24

▸ read24(offset: number): number

Reads a 24-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.

Returns: number

▸ read24(offset: number, offsetPlus: Holder<number>): number

Reads a 24-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
offsetPlus	Holder<number>	The offset plus the value length.

Returns: number

---

read24Signed

▸ read24Signed(offset: number): number

Reads a 24-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.

Returns: number

▸ read24Signed(offset: number, offsetPlus: Holder<number>): number

Reads a 24-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
offsetPlus	Holder<number>	The offset plus the value length.

Returns: number

---

read2Signed

▸ read2Signed(offset: number, bitOffset: number): number

Reads a 2-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read3

▸ read3(offset: number, bitOffset: number): number

Reads a 3-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read32

▸ read32(offset: number): number

Reads a 32-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.

Returns: number

▸ read32(offset: number, offsetPlus: Holder<number>): number

Reads a 32-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
offsetPlus	Holder<number>	The offset plus the value length.

Returns: number

---

read32Signed

▸ read32Signed(offset: number): number

Reads a 32-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.

Returns: number

▸ read32Signed(offset: number, offsetPlus: Holder<number>): number

Reads a 32-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
offsetPlus	Holder<number>	The offset plus the value length.

Returns: number

---

read3Signed

▸ read3Signed(offset: number, bitOffset: number): number

Reads a 3-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read4

▸ read4(offset: number, bitOffset: number): number

Reads a 4-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read40

▸ read40(offset: number): number

Reads a 40-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.

Returns: number

▸ read40(offset: number, offsetPlus: Holder<number>): number

Reads a 40-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
offsetPlus	Holder<number>	The offset plus the value length.

Returns: number

---

read40Signed

▸ read40Signed(offset: number): number

Reads a 40-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.

Returns: number

▸ read40Signed(offset: number, offsetPlus: Holder<number>): number

Reads a 40-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
offsetPlus	Holder<number>	The offset plus the value length.

Returns: number

---

read48

▸ read48(offset: number): number

Reads a 48-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.

Returns: number

▸ read48(offset: number, offsetPlus: Holder<number>): number

Reads a 48-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
offsetPlus	Holder<number>	The offset plus the value length.

Returns: number

---

read48Signed

▸ read48Signed(offset: number): number

Reads a 48-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.

Returns: number

▸ read48Signed(offset: number, offsetPlus: Holder<number>): number

Reads a 48-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
offsetPlus	Holder<number>	The offset plus the value length.

Returns: number

---

read4Signed

▸ read4Signed(offset: number, bitOffset: number): number

Reads a 4-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read5

▸ read5(offset: number, bitOffset: number): number

Reads a 5-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read56

▸ read56(offset: number): number

Reads a 56-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.

Returns: number

▸ read56(offset: number, offsetPlus: Holder<number>): number

Reads a 56-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
offsetPlus	Holder<number>	The offset plus the value length.

Returns: number

---

read56Signed

▸ read56Signed(offset: number): number

Reads a 56-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.

Returns: number

▸ read56Signed(offset: number, offsetPlus: Holder<number>): number

Reads a 56-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
offsetPlus	Holder<number>	The offset plus the value length.

Returns: number

---

read5Signed

▸ read5Signed(offset: number, bitOffset: number): number

Reads a 5-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read6

▸ read6(offset: number, bitOffset: number): number

Reads a 6-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read64

▸ read64(offset: number): number

Reads a 64-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.

Returns: number

▸ read64(offset: number, offsetPlus: Holder<number>): number

Reads a 64-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
offsetPlus	Holder<number>	The offset plus the value length.

Returns: number

---

read64Signed

▸ read64Signed(offset: number): number

Reads a 64-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.

Returns: number

▸ read64Signed(offset: number, offsetPlus: Holder<number>): number

Reads a 64-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
offsetPlus	Holder<number>	The offset plus the value length.

Returns: number

---

read6Signed

▸ read6Signed(offset: number, bitOffset: number): number

Reads a 6-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read7

▸ read7(offset: number, bitOffset: number): number

Reads a 7-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read7Signed

▸ read7Signed(offset: number, bitOffset: number): number

Reads a 7-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

read8

▸ read8(offset: number): number

Reads an 8-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.

Returns: number

▸ read8(offset: number, offsetPlus: Holder<number>): number

Reads an 8-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
offsetPlus	Holder<number>	The offset plus the value length.

Returns: number

---

read8Signed

▸ read8Signed(offset: number): number

Reads an 8-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.

Returns: number

▸ read8Signed(offset: number, offsetPlus: Holder<number>): number

Reads an 8-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
offsetPlus	Holder<number>	The offset plus the value length.

Returns: number

---

read9

▸ read9(offset: number, bitOffset: number): number

Reads a 9-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bitoffset.

Returns: number

---

read9Signed

▸ read9Signed(offset: number, bitOffset: number): number

Reads a 9-bit signed value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: number

---

readUtf8String

▸ readUtf8String(offset: number): string

Read a UTF-8 string.

Parameters:

Name	Type	Description
offset	number	The offset.

Returns: string

▸ readUtf8String(offset: number, length: number): string

Reads a UTF-8 string.

Parameters:

Name	Type	Description
offset	number	The offset.
length	number	The length.

Returns: string

---

resize

▸ resize(newLength: number): void

Resizes this buffer to a new length with new data being inserted at the end.

Parameters:

Name	Type	Description
newLength	number	The new length.

Returns: void

▸ resize(newLength: number, offset: number): void

Resizes this buffer to a new length with new data being inserted at a given offset.

Parameters:

Name	Type	Description
newLength	number	The new length.
offset	number	The offset.

Returns: void

▸ resize(newLength: number, offset: number, setZero: boolean): void

Resizes this buffer to a new length with new data being inserted at a given offset.

Parameters:

Name	Type	Description
newLength	number	The new length.
offset	number	The offset.
setZero	boolean	Sets empty space to zero.

Returns: void

---

sequenceEquals

▸ sequenceEquals(buffer: DataBuffer): boolean

Compares a data buffer for equality.

Parameters:

Name	Type	Description
buffer	DataBuffer	The data buffer.

Returns: boolean

true if the sequences are equal; otherwise, false.

---

sequenceEqualsConstantTime

▸ sequenceEqualsConstantTime(buffer: DataBuffer): boolean

Compares a data buffer for equality in constant time.

Parameters:

Name	Type	Description
buffer	DataBuffer	The buffer.

Returns: boolean

true if the sequences are equal; otherwise, false.

---

set

▸ set(value: number): void

Sets the data buffer to the specified value.

Parameters:

Name	Type	Description
value	number	The value.

Returns: void

▸ set(value: number, offset: number): void

Sets a subset of the data buffer to the specified value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.

Returns: void

▸ set(value: number, offset: number, length: number): void

Sets a subset of the data buffer to the specified value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
length	number	The length.

Returns: void

---

setInnerData

▸ ProtectedsetInnerData(value: Uint8Array): void

Sets backing data buffer.

Parameters:

Name	Type
value	Uint8Array

Returns: void

---

setLittleEndian

▸ setLittleEndian(value: boolean): void

Sets whether [[fm.liveswitch.dataBuffer.data]] is little-endian.

Parameters:

Name	Type
value	boolean

Returns: void

---

subset

▸ subset(offset: number): DataBuffer

Gets a subset of this instance.

Parameters:

Name	Type	Description
offset	number	The offset.

Returns: DataBuffer

▸ subset(offset: number, length: number): DataBuffer

Gets a subset of this instance.

Parameters:

Name	Type	Description
offset	number	The offset.
length	number	The length.

Returns: DataBuffer

---

toArray

▸ toArray(): Uint8Array

Converts this instance to an array of bytes.

Returns: Uint8Array

---

toBytes

▸ toBytes(): Uint8Array

Converts this instance to an array of bytes.

Returns: Uint8Array

---

toHexString

▸ toHexString(): string

Converts this instance to a hexadecimal string.

Returns: string

---

toJson

▸ toJson(): string

Serializes this instance to JSON.

Returns: string

---

tryKeep

▸ tryKeep(): boolean

Attempts to increment the retain count by one.

Returns: boolean

True if successful.

---

tryRead1

▸ tryRead1(offset: number, bitOffset: number, value: Holder<boolean>): boolean

Tries to read a 1-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.
value	Holder<boolean>	if set to true [value].

Returns: boolean

---

tryRead10

▸ tryRead10(offset: number, bitOffset: number, value: Holder<number>): boolean

Tries to read a 10-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.
value	Holder<number>	The value.

Returns: boolean

---

tryRead11

▸ tryRead11(offset: number, bitOffset: number, value: Holder<number>): boolean

Tries to read an 11-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.
value	Holder<number>	The value.

Returns: boolean

---

tryRead12

▸ tryRead12(offset: number, bitOffset: number, value: Holder<number>): boolean

Tries to read a 12-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.
value	Holder<number>	The value.

Returns: boolean

---

tryRead13

▸ tryRead13(offset: number, bitOffset: number, value: Holder<number>): boolean

Tries to read a 13-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.
value	Holder<number>	The value.

Returns: boolean

---

tryRead14

▸ tryRead14(offset: number, bitOffset: number, value: Holder<number>): boolean

Tries to read a 14-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.
value	Holder<number>	The value.

Returns: boolean

---

tryRead15

▸ tryRead15(offset: number, bitOffset: number, value: Holder<number>): boolean

Tries to read a 15-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.
value	Holder<number>	The value.

Returns: boolean

---

tryRead16

▸ tryRead16(offset: number, value: Holder<number>): boolean

Tries to read a 16-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
value	Holder<number>	The value.

Returns: boolean

---

tryRead17

▸ tryRead17(offset: number, bitOffset: number, value: Holder<number>): boolean

Tries to read a 17-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.
value	Holder<number>	The value.

Returns: boolean

---

tryRead18

▸ tryRead18(offset: number, bitOffset: number, value: Holder<number>): boolean

Tries to read an 18-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.
value	Holder<number>	The value.

Returns: boolean

---

tryRead19

▸ tryRead19(offset: number, bitOffset: number, value: Holder<number>): boolean

Tries to read a 19-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.
value	Holder<number>	The value.

Returns: boolean

---

tryRead2

▸ tryRead2(offset: number, bitOffset: number, value: Holder<number>): boolean

Tries to read a 2-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.
value	Holder<number>	The value.

Returns: boolean

---

tryRead20

▸ tryRead20(offset: number, bitOffset: number, value: Holder<number>): boolean

Tries to read a 20-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.
value	Holder<number>	The value.

Returns: boolean

---

tryRead21

▸ tryRead21(offset: number, bitOffset: number, value: Holder<number>): boolean

Tries to read a 21-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.
value	Holder<number>	The value.

Returns: boolean

---

tryRead22

▸ tryRead22(offset: number, bitOffset: number, value: Holder<number>): boolean

Tries to read a 22-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.
value	Holder<number>	The value.

Returns: boolean

---

tryRead23

▸ tryRead23(offset: number, bitOffset: number, value: Holder<number>): boolean

Tries to read a 23-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.
value	Holder<number>	The value.

Returns: boolean

---

tryRead24

▸ tryRead24(offset: number, value: Holder<number>): boolean

Tries to read a 24-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
value	Holder<number>	The value.

Returns: boolean

---

tryRead3

▸ tryRead3(offset: number, bitOffset: number, value: Holder<number>): boolean

Tries to read a 3-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.
value	Holder<number>	The value.

Returns: boolean

---

tryRead32

▸ tryRead32(offset: number, value: Holder<number>): boolean

Tries to read a 32-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
value	Holder<number>	The value.

Returns: boolean

---

tryRead4

▸ tryRead4(offset: number, bitOffset: number, value: Holder<number>): boolean

Tries to read a 4-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.
value	Holder<number>	The value.

Returns: boolean

---

tryRead40

▸ tryRead40(offset: number, value: Holder<number>): boolean

Tries to read a 40-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
value	Holder<number>	The value.

Returns: boolean

---

tryRead48

▸ tryRead48(offset: number, value: Holder<number>): boolean

Tries to read a 48-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
value	Holder<number>	The value.

Returns: boolean

---

tryRead5

▸ tryRead5(offset: number, bitOffset: number, value: Holder<number>): boolean

Tries to read a 5-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.
value	Holder<number>	The value.

Returns: boolean

---

tryRead56

▸ tryRead56(offset: number, value: Holder<number>): boolean

Tries to read a 56-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
value	Holder<number>	The value.

Returns: boolean

---

tryRead6

▸ tryRead6(offset: number, bitOffset: number, value: Holder<number>): boolean

Tries to read a 6-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.
value	Holder<number>	The value.

Returns: boolean

---

tryRead64

▸ tryRead64(offset: number, value: Holder<number>): boolean

Tries to read a 64-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
value	Holder<number>	The value.

Returns: boolean

---

tryRead7

▸ tryRead7(offset: number, bitOffset: number, value: Holder<number>): boolean

Tries to read a 7-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.
value	Holder<number>	The value.

Returns: boolean

---

tryRead8

▸ tryRead8(offset: number, value: Holder<number>): boolean

Tries to read an 8-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
value	Holder<number>	The value.

Returns: boolean

---

tryRead9

▸ tryRead9(offset: number, bitOffset: number, value: Holder<number>): boolean

Tries to read a 9-bit value.

Parameters:

Name	Type	Description
offset	number	The offset.
bitOffset	number	The bit offset.
value	Holder<number>	The value.

Returns: boolean

---

write

▸ write(buffer: DataBuffer): void

Writes a data buffer to this instance.

Parameters:

Name	Type	Description
buffer	DataBuffer	The buffer.

Returns: void

▸ write(buffer: DataBuffer, offset: number): void

Writes a data buffer to this instance.

Parameters:

Name	Type	Description
buffer	DataBuffer	The buffer.
offset	number	The offset.

Returns: void

▸ write(buffer: DataBuffer, offset: number, offsetPlus: Holder<number>): void

Writes a data buffer to this instance.

Parameters:

Name	Type	Description
buffer	DataBuffer	The buffer.
offset	number	The offset.
offsetPlus	Holder<number>	The offset plus the buffer length.

Returns: void

---

write1

▸ write1(value: boolean, offset: number, bitOffset: number): boolean

Writes a 1-bit value.

Parameters:

Name	Type	Description
value	boolean	The value.
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: boolean

---

write10

▸ write10(value: number, offset: number, bitOffset: number): boolean

Writes a 10-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: boolean

---

write11

▸ write11(value: number, offset: number, bitOffset: number): boolean

Writes an 11-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: boolean

---

write12

▸ write12(value: number, offset: number, bitOffset: number): boolean

Writes a 12-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: boolean

---

write13

▸ write13(value: number, offset: number, bitOffset: number): boolean

Writes a 13-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: boolean

---

write14

▸ write14(value: number, offset: number, bitOffset: number): boolean

Writes a 14-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: boolean

---

write15

▸ write15(value: number, offset: number, bitOffset: number): boolean

Writes a 15-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: boolean

---

write16

▸ write16(value: number, offset: number): boolean

Writes a 16-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.

Returns: boolean

▸ write16(value: number, offset: number, offsetPlus: Holder<number>): boolean

Writes a 16-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
offsetPlus	Holder<number>	The offset plus the value length.

Returns: boolean

---

write17

▸ write17(value: number, offset: number, bitOffset: number): boolean

Writes a 17-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: boolean

---

write18

▸ write18(value: number, offset: number, bitOffset: number): boolean

Writes an 18-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: boolean

---

write19

▸ write19(value: number, offset: number, bitOffset: number): boolean

Writes a 19-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: boolean

---

write2

▸ write2(value: number, offset: number, bitOffset: number): boolean

Writes a 2-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: boolean

---

write20

▸ write20(value: number, offset: number, bitOffset: number): boolean

Writes a 20-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: boolean

---

write21

▸ write21(value: number, offset: number, bitOffset: number): boolean

Writes a 21-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: boolean

---

write22

▸ write22(value: number, offset: number, bitOffset: number): boolean

Writes a 22-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: boolean

---

write23

▸ write23(value: number, offset: number, bitOffset: number): boolean

Writes a 23-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: boolean

---

write24

▸ write24(value: number, offset: number): boolean

Writes a 24-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.

Returns: boolean

▸ write24(value: number, offset: number, offsetPlus: Holder<number>): boolean

Writes a 24-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
offsetPlus	Holder<number>	The offset plus the value length.

Returns: boolean

---

write3

▸ write3(value: number, offset: number, bitOffset: number): boolean

Writes a 3-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: boolean

---

write32

▸ write32(value: number, offset: number): boolean

Writes a 32-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.

Returns: boolean

▸ write32(value: number, offset: number, offsetPlus: Holder<number>): boolean

Writes a 32-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
offsetPlus	Holder<number>	The offset plus the value length.

Returns: boolean

---

write4

▸ write4(value: number, offset: number, bitOffset: number): boolean

Writes a 4-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: boolean

---

write40

▸ write40(value: number, offset: number): boolean

Writes a 40-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.

Returns: boolean

▸ write40(value: number, offset: number, offsetPlus: Holder<number>): boolean

Writes a 40-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
offsetPlus	Holder<number>	The offset plus the value length.

Returns: boolean

---

write48

▸ write48(value: number, offset: number): boolean

Writes a 48-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.

Returns: boolean

▸ write48(value: number, offset: number, offsetPlus: Holder<number>): boolean

Writes a 48-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
offsetPlus	Holder<number>	The offset plus the value length.

Returns: boolean

---

write5

▸ write5(value: number, offset: number, bitOffset: number): boolean

Writes a 5-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: boolean

---

write56

▸ write56(value: number, offset: number): boolean

Writes a 56-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.

Returns: boolean

▸ write56(value: number, offset: number, offsetPlus: Holder<number>): boolean

Writes a 56-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
offsetPlus	Holder<number>	The offset plus the value length.

Returns: boolean

---

write6

▸ write6(value: number, offset: number, bitOffset: number): boolean

Writes a 6-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: boolean

---

write64

▸ write64(value: number, offset: number): boolean

Writes a 64-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.

Returns: boolean

▸ write64(value: number, offset: number, offsetPlus: Holder<number>): boolean

Writes a 64-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
offsetPlus	Holder<number>	The offset plus the value length.

Returns: boolean

---

write7

▸ write7(value: number, offset: number, bitOffset: number): boolean

Writes a 7-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: boolean

---

write8

▸ write8(value: number, offset: number): boolean

Writes an 8-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.

Returns: boolean

▸ write8(value: number, offset: number, offsetPlus: Holder<number>): boolean

Writes an 8-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
offsetPlus	Holder<number>	The offset plus the value length.

Returns: boolean

---

write9

▸ write9(value: number, offset: number, bitOffset: number): boolean

Writes a 9-bit value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.
bitOffset	number	The bit offset.

Returns: boolean

---

writeBytes

▸ writeBytes(bytes: Uint8Array): void

Writes a byte array to this instance.

Parameters:

Name	Type	Description
bytes	Uint8Array	The bytes.

Returns: void

▸ writeBytes(bytes: Uint8Array, bytesIndex: number, bytesLength: number, offset: number): void

Writes a byte array to this instance.

Parameters:

Name	Type	Description
bytes	Uint8Array	The bytes.
bytesIndex	number	The bytes index.
bytesLength	number	The bytes length.
offset	number	The offset.

Returns: void

▸ writeBytes(bytes: Uint8Array, bytesIndex: number, bytesLength: number, offset: number, offsetPlus: Holder<number>): void

Writes a byte array to this instance.

Parameters:

Name	Type	Description
bytes	Uint8Array	The bytes.
bytesIndex	number	The bytes index.
bytesLength	number	The bytes length.
offset	number	The offset.
offsetPlus	Holder<number>	The offset plus the buffer length.

Returns: void

▸ writeBytes(bytes: Uint8Array, bytesIndex: number, offset: number): void

Writes a byte array to this instance.

Parameters:

Name	Type	Description
bytes	Uint8Array	The bytes.
bytesIndex	number	The bytes index.
offset	number	The offset.

Returns: void

▸ writeBytes(bytes: Uint8Array, offset: number): void

Writes a byte array to this instance.

Parameters:

Name	Type	Description
bytes	Uint8Array	The bytes.
offset	number	The offset.

Returns: void

---

xor

▸ xor(value: number, offset: number): boolean

Performs a bitwise "xor" operation on a value.

Parameters:

Name	Type	Description
value	number	The value.
offset	number	The offset.

Returns: boolean

---

allocate

▸ Staticallocate(count: number): DataBuffer

Allocates a new data buffer with a given size (in bytes) in big-endian format.

Parameters:

Name	Type	Description
count	number	Pre-allocated data buffer size (in bytes).

Returns: DataBuffer

▸ Staticallocate(count: number, littleEndian: boolean): DataBuffer

Allocates a new data buffer with a given size (in bytes).

Parameters:

Name	Type	Description
count	number	Pre-allocated data buffer size (in bytes).
littleEndian	boolean	Whether the data is little-endian.

Returns: DataBuffer

---

areEqual

▸ StaticareEqual(buffer1: DataBuffer, buffer2: DataBuffer): boolean

Tests if the two buffers have equal contents.

Parameters:

Name	Type	Description
buffer1	DataBuffer	First buffer to test.
buffer2	DataBuffer	Second buffer to test.

Returns: boolean

---

fromBytes

▸ StaticfromBytes(bytes: Uint8Array): DataBuffer

Creates an instance from an array of bytes.

Parameters:

Name	Type
bytes	Uint8Array

Returns: DataBuffer

▸ StaticfromBytes(bytes: Uint8Array, littleEndian: boolean): DataBuffer

Creates an instance from an array of bytes.

Parameters:

Name	Type
bytes	Uint8Array
littleEndian	boolean

Returns: DataBuffer

---

fromHexString

▸ StaticfromHexString(hexString: string): DataBuffer

Creates an instance from a hexadecimal string.

Parameters:

Name	Type
hexString	string

Returns: DataBuffer

▸ StaticfromHexString(hexString: string, littleEndian: boolean): DataBuffer

Creates an instance from a hexadecimal string.

Parameters:

Name	Type
hexString	string
littleEndian	boolean

Returns: DataBuffer

---

fromJson

▸ StaticfromJson(dataBufferJson: string): DataBuffer

Deserializes an instance from JSON.

Parameters:

Name	Type	Description
dataBufferJson	string	The data buffer JSON.

Returns: DataBuffer

---

fromJsonArray

▸ StaticfromJsonArray(dataBuffersJson: string): DataBuffer[]

Deserializes an array of instances from JSON.

Parameters:

Name	Type	Description
dataBuffersJson	string	The data buffers JSON.

Returns: DataBuffer[]

---

getEmpty

▸ StaticgetEmpty(): DataBuffer

Gets an empty data buffer.

Returns: DataBuffer

---

toJson

▸ StatictoJson(dataBuffer: DataBuffer): string

Serializes an instance to JSON.

Parameters:

Name	Type	Description
dataBuffer	DataBuffer	The data buffer.

Returns: string

---

toJsonArray

▸ StatictoJsonArray(dataBuffers: DataBuffer[]): string

Serializes an array of instances to JSON.

Parameters:

Name	Type	Description
dataBuffers	DataBuffer[]	The data buffers.

Returns: string

---

wrap

▸ Staticwrap(data: Uint8Array): DataBuffer

Produces a new data buffer containing supplied data in big-endian format.

Parameters:

Name	Type	Description
data	Uint8Array	The data.

Returns: DataBuffer

▸ Staticwrap(data: Uint8Array, index: number): DataBuffer

Produces a new data buffer containing supplied data in big-endian format.

Parameters:

Name	Type	Description
data	Uint8Array	The data.
index	number	The index.

Returns: DataBuffer

▸ Staticwrap(data: Uint8Array, index: number, length: number): DataBuffer

Produces a new data buffer containing supplied data in big-endian format.

Parameters:

Name	Type	Description
data	Uint8Array	The data.
index	number	The index.
length	number	The length.

Returns: DataBuffer

▸ Staticwrap(data: Uint8Array, index: number, length: number, littleEndian: boolean): DataBuffer

Produces a new data buffer containing supplied data.

Parameters:

Name	Type	Description
data	Uint8Array	The data.
index	number	The index.
length	number	The length.
littleEndian	boolean	Whether the data is little-endian.

Returns: DataBuffer

▸ Staticwrap(data: Uint8Array, index: number, littleEndian: boolean): DataBuffer

Produces a new data buffer containing supplied data.

Parameters:

Name	Type	Description
data	Uint8Array	The data.
index	number	The index.
littleEndian	boolean	Whether the data is little-endian.

Returns: DataBuffer

▸ Staticwrap(data: Uint8Array, littleEndian: boolean): DataBuffer

Produces a new data buffer containing supplied data.

Parameters:

Name	Type	Description
data	Uint8Array	The data.
littleEndian	boolean	Whether the data is little-endian.

Returns: DataBuffer