|
| 1 | +/*** |
| 2 | +Functions for interacting with JavaScript ArrayBuffer. |
| 3 | +See: [`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer). |
| 4 | +*/ |
| 5 | + |
| 6 | +/** |
| 7 | +Type representing an ArrayBuffer object used to represent a generic raw binary data buffer. |
| 8 | +*/ |
| 9 | +@notUndefined |
| 10 | +type t |
| 11 | + |
| 12 | +/** |
| 13 | +`make(length)` creates a new ArrayBuffer with the specified length in bytes. |
| 14 | +See [`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer/ArrayBuffer) on MDN. |
| 15 | +
|
| 16 | +## Examples |
| 17 | +
|
| 18 | +```rescript |
| 19 | +let buffer = ArrayBuffer.make(8) |
| 20 | +ArrayBuffer.byteLength(buffer) == 8 |
| 21 | +``` |
| 22 | +
|
| 23 | +## Exceptions |
| 24 | +
|
| 25 | +- `RangeError`: If `length` is larger than `Number.MAX_SAFE_INTEGER` or negative. |
| 26 | +*/ |
| 27 | +@new external make: int => t = "ArrayBuffer" |
| 28 | + |
| 29 | +/** |
| 30 | +`byteLength(arrayBuffer)` returns the size, in bytes, of the ArrayBuffer. |
| 31 | +See [`ArrayBuffer.byteLength`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer/byteLength) on MDN. |
| 32 | +
|
| 33 | +## Examples |
| 34 | +
|
| 35 | +```rescript |
| 36 | +let buffer = ArrayBuffer.make(16) |
| 37 | +ArrayBuffer.byteLength(buffer) == 16 |
| 38 | +``` |
| 39 | +*/ |
| 40 | +@get external byteLength: t => int = "byteLength" |
| 41 | + |
| 42 | +/** |
| 43 | +`slice(arrayBuffer, ~start, ~end)` returns a new ArrayBuffer whose contents are a copy of this ArrayBuffer's bytes from `start`, inclusive, up to `end`, exclusive. |
| 44 | +See [`ArrayBuffer.slice`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer/slice) on MDN. |
| 45 | +
|
| 46 | +## Examples |
| 47 | +
|
| 48 | +```rescript |
| 49 | +let buffer = ArrayBuffer.make(16) |
| 50 | +let sliced = buffer->ArrayBuffer.slice(~start=4, ~end=12) |
| 51 | +ArrayBuffer.byteLength(sliced) == 8 |
| 52 | +``` |
| 53 | +*/ |
| 54 | +@send external slice: (t, ~start: int=?, ~end: int=?) => t = "slice" |
| 55 | + |
| 56 | +@deprecated("Use `slice` instead.") @send external sliceToEnd: (t, ~start: int) => t = "slice" |
0 commit comments