Class BiniDataView

Hierarchy

jDataView
- BiniDataView

Constructors

constructor

new BiniDataView(buffer, filePath): BiniDataView
Parameters
- buffer: Uint8Array
- filePath: string
Returns BiniDataView
Overrides jDataView.constructor
- Defined in src/BiniDataView.ts:7

Properties

`Readonly` [toStringTag]

[toStringTag]: string

buffer

buffer: any

byteLength

byteLength: number

byteOffset

byteOffset: number

filePath

filePath: string

Methods

createBuffer

createBuffer(...bytes): Buffer
Parameters
- Rest ...bytes: number[]
Returns Buffer
Inherited from jDataView.createBuffer
- Defined in node_modules/@types/jdataview/index.d.ts:29

getBigInt64

getBigInt64(byteOffset, littleEndian?): bigint
Gets the BigInt64 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.
Parameters
- byteOffset: number
  The place in the buffer at which the value should be retrieved.
- Optional littleEndian: boolean
  If false or undefined, a big-endian value should be read.
Returns bigint
Inherited from jDataView.getBigInt64
- Defined in ../../../../Users/David/AppData/Local/npm-cache/_npx/dafcb7cdaad6ed61/node_modules/typescript/lib/lib.es2020.bigint.d.ts:696

getBigUint64

getBigUint64(byteOffset, littleEndian?): bigint
Gets the BigUint64 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.
Parameters
- byteOffset: number
  The place in the buffer at which the value should be retrieved.
- Optional littleEndian: boolean
  If false or undefined, a big-endian value should be read.
Returns bigint
Inherited from jDataView.getBigUint64
- Defined in ../../../../Users/David/AppData/Local/npm-cache/_npx/dafcb7cdaad6ed61/node_modules/typescript/lib/lib.es2020.bigint.d.ts:704

getBytes

getBytes(length, byteOffset?, littleEndian?, toArray?): number[]
Parameters
- length: number
- Optional byteOffset: number
- Optional littleEndian: boolean
- Optional toArray: boolean
Returns number[]
Inherited from jDataView.getBytes
- Defined in node_modules/@types/jdataview/index.d.ts:64

getChar

getChar(byteOffset?): string
Parameters
- Optional byteOffset: number
Returns string
Inherited from jDataView.getChar
- Defined in node_modules/@types/jdataview/index.d.ts:58

getFloat32

getFloat32(byteOffset?, littleEndian?): number
Parameters
- Optional byteOffset: number
- Optional littleEndian: boolean
Returns number
Inherited from jDataView.getFloat32
- Defined in node_modules/@types/jdataview/index.d.ts:44

getFloat64

getFloat64(byteOffset?, littleEndian?): number
Parameters
- Optional byteOffset: number
- Optional littleEndian: boolean
Returns number
Inherited from jDataView.getFloat64
- Defined in node_modules/@types/jdataview/index.d.ts:45

getInt16

getInt16(byteOffset?, littleEndian?): number
Parameters
- Optional byteOffset: number
- Optional littleEndian: boolean
Returns number
Inherited from jDataView.getInt16
- Defined in node_modules/@types/jdataview/index.d.ts:40

getInt32

getInt32(byteOffset?, littleEndian?): number
Parameters
- Optional byteOffset: number
- Optional littleEndian: boolean
Returns number
Inherited from jDataView.getInt32
- Defined in node_modules/@types/jdataview/index.d.ts:42

getInt64

getInt64(byteOffset?, littleEndian?): Int64
Parameters
- Optional byteOffset: number
- Optional littleEndian: boolean
Returns Int64
Inherited from jDataView.getInt64
- Defined in node_modules/@types/jdataview/index.d.ts:10

getInt8

getInt8(byteOffset?): number
Parameters
- Optional byteOffset: number
Returns number
Inherited from jDataView.getInt8
- Defined in node_modules/@types/jdataview/index.d.ts:38

getReverseInt16

getReverseInt16(): number
Returns number
- Defined in src/BiniDataView.ts:16

getReverseInt32

getReverseInt32(): number
Returns number
- Defined in src/BiniDataView.ts:11

getSigned

getSigned(bitLength, byteOffset?): number
Parameters
- bitLength: number
- Optional byteOffset: number
Returns number
Inherited from jDataView.getSigned
- Defined in node_modules/@types/jdataview/index.d.ts:18

getString

getString(byteLength, byteOffset?, encoding?): string
Parameters
- byteLength: number
- Optional byteOffset: number
- Optional encoding: string
Returns string
Inherited from jDataView.getString
- Defined in node_modules/@types/jdataview/index.d.ts:61

getUint16

getUint16(byteOffset?, littleEndian?): number
Parameters
- Optional byteOffset: number
- Optional littleEndian: boolean
Returns number
Inherited from jDataView.getUint16
- Defined in node_modules/@types/jdataview/index.d.ts:41

getUint32

getUint32(byteOffset?, littleEndian?): number
Parameters
- Optional byteOffset: number
- Optional littleEndian: boolean
Returns number
Inherited from jDataView.getUint32
- Defined in node_modules/@types/jdataview/index.d.ts:43

getUint64

getUint64(byteOffset?, littleEndian?): Uint64
Parameters
- Optional byteOffset: number
- Optional littleEndian: boolean
Returns Uint64
Inherited from jDataView.getUint64
- Defined in node_modules/@types/jdataview/index.d.ts:13

getUint8

getUint8(byteOffset?): number
Parameters
- Optional byteOffset: number
Returns number
Inherited from jDataView.getUint8
- Defined in node_modules/@types/jdataview/index.d.ts:39

getUnsigned

getUnsigned(bitLength, byteOffset?): number
Parameters
- bitLength: number
- Optional byteOffset: number
Returns number
Inherited from jDataView.getUnsigned
- Defined in node_modules/@types/jdataview/index.d.ts:21

readBiniFile

readBiniFile(byteLength): Section[]
Reads the BINI file this data view is currently viewing.
Parameters
- byteLength: number
  the byteLength of the array passed in the ctor.
Returns Section[]
- Defined in src/BiniDataView.ts:25

seek

seek(byteOffset): number
Parameters
- byteOffset: number
Returns number
Inherited from jDataView.seek
- Defined in node_modules/@types/jdataview/index.d.ts:32

setBigInt64

setBigInt64(byteOffset, value, littleEndian?): void
Stores a BigInt64 value at the specified byte offset from the start of the view.
Parameters
- byteOffset: number
  The place in the buffer at which the value should be set.
- value: bigint
  The value to set.
- Optional littleEndian: boolean
  If false or undefined, a big-endian value should be written.
Returns void
Inherited from jDataView.setBigInt64
- Defined in ../../../../Users/David/AppData/Local/npm-cache/_npx/dafcb7cdaad6ed61/node_modules/typescript/lib/lib.es2020.bigint.d.ts:712

setBigUint64

setBigUint64(byteOffset, value, littleEndian?): void
Stores a BigUint64 value at the specified byte offset from the start of the view.
Parameters
- byteOffset: number
  The place in the buffer at which the value should be set.
- value: bigint
  The value to set.
- Optional littleEndian: boolean
  If false or undefined, a big-endian value should be written.
Returns void
Inherited from jDataView.setBigUint64
- Defined in ../../../../Users/David/AppData/Local/npm-cache/_npx/dafcb7cdaad6ed61/node_modules/typescript/lib/lib.es2020.bigint.d.ts:720

setBytes

setBytes(byteOffset, bytes, littleEndian?): void
Parameters
- byteOffset: number
- bytes: number[]
- Optional littleEndian: boolean
Returns void
Inherited from jDataView.setBytes
- Defined in node_modules/@types/jdataview/index.d.ts:65

setChar

setChar(byteOffset, char): void
Parameters
- byteOffset: number
- char: string
Returns void
Inherited from jDataView.setChar
- Defined in node_modules/@types/jdataview/index.d.ts:59

setFloat32

setFloat32(byteOffset, value, littleEndian?): void
Parameters
- byteOffset: number
- value: number
- Optional littleEndian: boolean
Returns void
Inherited from jDataView.setFloat32
- Defined in node_modules/@types/jdataview/index.d.ts:54

setFloat64

setFloat64(byteOffset, value, littleEndian?): void
Parameters
- byteOffset: number
- value: number
- Optional littleEndian: boolean
Returns void
Inherited from jDataView.setFloat64
- Defined in node_modules/@types/jdataview/index.d.ts:55

setInt16

setInt16(byteOffset, value, littleEndian?): void
Parameters
- byteOffset: number
- value: number
- Optional littleEndian: boolean
Returns void
Inherited from jDataView.setInt16
- Defined in node_modules/@types/jdataview/index.d.ts:50

setInt32

setInt32(byteOffset, value, littleEndian?): void
Parameters
- byteOffset: number
- value: number
- Optional littleEndian: boolean
Returns void
Inherited from jDataView.setInt32
- Defined in node_modules/@types/jdataview/index.d.ts:52

setInt64

setInt64(byteOffset, value, littleEndian?): void
Parameters
- byteOffset: number
- value: Int64
- Optional littleEndian: boolean
Returns void
Inherited from jDataView.setInt64
- Defined in node_modules/@types/jdataview/index.d.ts:11

setInt8

setInt8(byteOffset, value): void
Parameters
- byteOffset: number
- value: number
Returns void
Inherited from jDataView.setInt8
- Defined in node_modules/@types/jdataview/index.d.ts:48

setSigned

setSigned(byteOffset, value, bitLength): void
Parameters
- byteOffset: number
- value: number
- bitLength: number
Returns void
Inherited from jDataView.setSigned
- Defined in node_modules/@types/jdataview/index.d.ts:19

setString

setString(byteOffset, chars, encoding?): void
Parameters
- byteOffset: number
- chars: string
- Optional encoding: string
Returns void
Inherited from jDataView.setString
- Defined in node_modules/@types/jdataview/index.d.ts:62

setUint16

setUint16(byteOffset, value, littleEndian?): void
Parameters
- byteOffset: number
- value: number
- Optional littleEndian: boolean
Returns void
Inherited from jDataView.setUint16
- Defined in node_modules/@types/jdataview/index.d.ts:51

setUint32

setUint32(byteOffset, value, littleEndian?): void
Parameters
- byteOffset: number
- value: number
- Optional littleEndian: boolean
Returns void
Inherited from jDataView.setUint32
- Defined in node_modules/@types/jdataview/index.d.ts:53

setUint64

setUint64(byteOffset, value, littleEndian?): void
Parameters
- byteOffset: number
- value: Uint64
- Optional littleEndian: boolean
Returns void
Inherited from jDataView.setUint64
- Defined in node_modules/@types/jdataview/index.d.ts:14

setUint8

setUint8(byteOffset, value): void
Parameters
- byteOffset: number
- value: number
Returns void
Inherited from jDataView.setUint8
- Defined in node_modules/@types/jdataview/index.d.ts:49

setUnsigned

setUnsigned(byteOffset, value, bitLength): void
Parameters
- byteOffset: number
- value: number
- bitLength: number
Returns void
Inherited from jDataView.setUnsigned
- Defined in node_modules/@types/jdataview/index.d.ts:22

skip

skip(byteLength): number
Parameters
- byteLength: number
Returns number
Inherited from jDataView.skip
- Defined in node_modules/@types/jdataview/index.d.ts:34

slice

slice(start, end?, forceCopy?): jDataView
Parameters
- start: number
- Optional end: number
- Optional forceCopy: boolean
Returns jDataView
Inherited from jDataView.slice
- Defined in node_modules/@types/jdataview/index.d.ts:35

tell

tell(): number
Returns number
Inherited from jDataView.tell
- Defined in node_modules/@types/jdataview/index.d.ts:33

wrapBuffer

wrapBuffer(string): Buffer
Parameters
- string: string
Returns Buffer
Inherited from jDataView.wrapBuffer
- Defined in node_modules/@types/jdataview/index.d.ts:26
wrapBuffer(bytes): Buffer
Parameters
- bytes: Bytes
Returns Buffer
Inherited from jDataView.wrapBuffer
- Defined in node_modules/@types/jdataview/index.d.ts:27
wrapBuffer(byteCount): Buffer
Parameters
- byteCount: number
Returns Buffer
Inherited from jDataView.wrapBuffer
- Defined in node_modules/@types/jdataview/index.d.ts:28

writeBytes

writeBytes(bytes, littleEndian?): void
Parameters
- bytes: number[]
- Optional littleEndian: boolean
Returns void
Inherited from jDataView.writeBytes
- Defined in node_modules/@types/jdataview/index.d.ts:66

writeChar

writeChar(char): void
Parameters
- char: string
Returns void
Inherited from jDataView.writeChar
- Defined in node_modules/@types/jdataview/index.d.ts:60

writeFloat32

writeFloat32(value, littleEndian?): void
Parameters
- value: number
- Optional littleEndian: boolean
Returns void
Inherited from jDataView.writeFloat32
- Defined in node_modules/@types/jdataview/index.d.ts:75

writeFloat64

writeFloat64(value, littleEndian?): void
Parameters
- value: number
- Optional littleEndian: boolean
Returns void
Inherited from jDataView.writeFloat64
- Defined in node_modules/@types/jdataview/index.d.ts:76

writeInt16

writeInt16(value, littleEndian?): void
Parameters
- value: number
- Optional littleEndian: boolean
Returns void
Inherited from jDataView.writeInt16
- Defined in node_modules/@types/jdataview/index.d.ts:71

writeInt32

writeInt32(value, littleEndian?): void
Parameters
- value: number
- Optional littleEndian: boolean
Returns void
Inherited from jDataView.writeInt32
- Defined in node_modules/@types/jdataview/index.d.ts:73

writeInt64

writeInt64(value, littleEndian?): void
Parameters
- value: Int64
- Optional littleEndian: boolean
Returns void
Inherited from jDataView.writeInt64
- Defined in node_modules/@types/jdataview/index.d.ts:12

writeInt8

writeInt8(value): void
Parameters
- value: number
Returns void
Inherited from jDataView.writeInt8
- Defined in node_modules/@types/jdataview/index.d.ts:69

writeSigned

writeSigned(value, bitLength): void
Parameters
- value: number
- bitLength: number
Returns void
Inherited from jDataView.writeSigned
- Defined in node_modules/@types/jdataview/index.d.ts:20

writeString

writeString(chars, encoding?): void
Parameters
- chars: string
- Optional encoding: string
Returns void
Inherited from jDataView.writeString
- Defined in node_modules/@types/jdataview/index.d.ts:63

writeUint16

writeUint16(value, littleEndian?): void
Parameters
- value: number
- Optional littleEndian: boolean
Returns void
Inherited from jDataView.writeUint16
- Defined in node_modules/@types/jdataview/index.d.ts:72

writeUint32

writeUint32(value, littleEndian?): void
Parameters
- value: number
- Optional littleEndian: boolean
Returns void
Inherited from jDataView.writeUint32
- Defined in node_modules/@types/jdataview/index.d.ts:74

writeUint64

writeUint64(value, littleEndian?): void
Parameters
- value: Uint64
- Optional littleEndian: boolean
Returns void
Inherited from jDataView.writeUint64
- Defined in node_modules/@types/jdataview/index.d.ts:15

writeUint8

writeUint8(value): void
Parameters
- value: number
Returns void
Inherited from jDataView.writeUint8
- Defined in node_modules/@types/jdataview/index.d.ts:70

writeUnsigned

writeUnsigned(value, bitLength): void
Parameters
- value: number
- bitLength: number
Returns void
Inherited from jDataView.writeUnsigned
- Defined in node_modules/@types/jdataview/index.d.ts:23

Class BiniDataView

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

buffer: Uint8Array

filePath: string

Returns BiniDataView

Properties

Readonly [toStringTag]

buffer

byteLength

byteOffset

filePath

Methods

createBuffer

Parameters

Rest ...bytes: number[]

Returns Buffer

getBigInt64

Parameters

byteOffset: number

Optional littleEndian: boolean

Returns bigint

getBigUint64

Parameters

byteOffset: number

Optional littleEndian: boolean

Returns bigint

getBytes

Parameters

length: number

Optional byteOffset: number

Optional littleEndian: boolean

Optional toArray: boolean

Returns number[]

getChar

Parameters

Optional byteOffset: number

Returns string

getFloat32

Parameters

Optional byteOffset: number

Optional littleEndian: boolean

Returns number

getFloat64

Parameters

Optional byteOffset: number

Optional littleEndian: boolean

Returns number

getInt16

Parameters

Optional byteOffset: number

Optional littleEndian: boolean

Returns number

getInt32

Parameters

Optional byteOffset: number

Optional littleEndian: boolean

Returns number

getInt64

Parameters

Optional byteOffset: number

Optional littleEndian: boolean

Returns Int64

getInt8

Parameters

Optional byteOffset: number

Returns number

getReverseInt16

Returns number

getReverseInt32

Returns number

getSigned

Parameters

bitLength: number

`Readonly` [toStringTag]

`Rest` ...bytes: number[]

`Optional` littleEndian: boolean

`Optional` littleEndian: boolean

`Optional` byteOffset: number

`Optional` littleEndian: boolean

`Optional` toArray: boolean

`Optional` byteOffset: number

`Optional` byteOffset: number

`Optional` littleEndian: boolean

`Optional` byteOffset: number

`Optional` littleEndian: boolean

`Optional` byteOffset: number

`Optional` littleEndian: boolean

`Optional` byteOffset: number

`Optional` littleEndian: boolean

`Optional` byteOffset: number

`Optional` littleEndian: boolean

`Optional` byteOffset: number

`Optional` byteOffset: number

`Optional` byteOffset: number

`Optional` encoding: string

`Optional` byteOffset: number

`Optional` littleEndian: boolean

`Optional` byteOffset: number

`Optional` littleEndian: boolean

`Optional` byteOffset: number

`Optional` littleEndian: boolean

`Optional` byteOffset: number

`Optional` byteOffset: number

`Optional` littleEndian: boolean

`Optional` littleEndian: boolean

`Optional` littleEndian: boolean

`Optional` littleEndian: boolean