blob: c81d16fb5c119e9e7e14bf2a1594440babf0098e (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
/**
* TypedArray utils and conversions.
*
* ```js
* import { typedView } from '@exodus/bytes/array.js'
* ```
*
* @module @exodus/bytes/array.js
*/
/// <reference types="node" />
// >= TypeScript 5.9 made Uint8Array templated with <> and defaulted to ArrayBufferLike
// which would incorrectly accept SharedArrayBuffer instances.
// < TypeScript 5.7 doesn't support templates for Uint8Array.
// So this type is defined as a workaround to evaluate to Uint8Array<ArrayBuffer> on all versions of TypeScript.
/**
* This is `Uint8Array<ArrayBuffer>`
* (as opposed to `Uint8Array<SharedArrayBuffer>` and `Uint8Array<ArrayBufferLike>`)
* on TypeScript versions that support that distinction.
*
* On TypeScript < 5.7, this is just `Uint8Array`, as it's not a template there.
*/
export type Uint8ArrayBuffer = ReturnType<typeof Uint8Array.from>;
/**
* This is `Uint16Array<ArrayBuffer>`
* (as opposed to `Uint16Array<SharedArrayBuffer>` and `Uint16Array<ArrayBufferLike>`)
* on TypeScript versions that support that distinction.
*
* On TypeScript < 5.7, this is just `Uint16Array`, as it's not a template there.
*/
export type Uint16ArrayBuffer = ReturnType<typeof Uint16Array.from>;
/**
* This is `Uint32Array<ArrayBuffer>`
* (as opposed to `Uint32Array<SharedArrayBuffer>` and `Uint32Array<ArrayBufferLike>`)
* on TypeScript versions that support that distinction.
*
* On TypeScript < 5.7, this is just `Uint32Array`, as it's not a template there.
*/
export type Uint32ArrayBuffer = ReturnType<typeof Uint32Array.from>;
/**
* Output format for typed array conversions
*/
export type OutputFormat = 'uint8' | 'buffer';
/**
* Create a view of a TypedArray in the specified format (`'uint8'` or `'buffer'`)
*
* > [!IMPORTANT]
* > Does not copy data, returns a view on the same underlying buffer
*
* @param arr - The input TypedArray
* @param format - The desired output format (`'uint8'` or `'buffer'`)
* @returns A view on the same underlying buffer
*/
export function typedView(arr: ArrayBufferView, format: 'uint8'): Uint8Array;
export function typedView(arr: ArrayBufferView, format: 'buffer'): Buffer;
export function typedView(arr: ArrayBufferView, format: OutputFormat): Uint8Array | Buffer;
|
