Skip to content

Commit

Permalink
Added documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderOMara committed Nov 16, 2024
1 parent e5348bb commit c05f756
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,52 @@
# HQTSM: DataView

Extra DataView functions

# Features

- Pure TypeScript, run anywhere
- Optimized for speed and size

# Usage

## Float16

```js
import { getFloat16, setFloat16 } from '@hqtsm/dataview';

const data = new Uint8Array(4);
const view = new DataView(data.buffer);
setFloat16(view, 0, Math.PI);
setFloat16(view, 2, Math.LN10, true);
console.log(data); // Uint8Array(4) [ 66, 72, 155, 64 ]
console.log(getFloat16(view, 0)); // 3.140625
console.log(getFloat16(view, 2, true)); // 2.302734375
```

## Int24

```js
import { getInt24, setInt24 } from '@hqtsm/dataview';

const data = new Uint8Array(6);
const view = new DataView(data.buffer);
setInt24(view, 0, -1234);
setInt24(view, 3, -4567, true);
console.log(data); // Uint8Array(6) [ 255, 251, 46, 41, 238, 255 ]
console.log(getInt24(view, 0)); // -1234
console.log(getInt24(view, 3, true)); // -4567
```

## Uint24

```js
import { getUint24, setUint24 } from '@hqtsm/dataview';

const data = new Uint8Array(6);
const view = new DataView(data.buffer);
setUint24(view, 0, 12345678);
setUint24(view, 3, 11223344, true);
console.log(data); // Uint8Array(6) [ 188, 97, 78, 48, 65, 171 ]
console.log(getUint24(view, 0)); // 12345678
console.log(getUint24(view, 3, true)); // 11223344
```

0 comments on commit c05f756

Please sign in to comment.