array buffer like - nberlette/is GitHub Wiki

@nick/is/array-buffer-like

isArrayBufferLike

Signature

function isArrayBufferLike(it: unknown): it is ArrayBufferLike;

Checks if it is an ArrayBuffer or a SharedArrayBuffer.

Parameters
Name Info
it The value to check.
Returns

true if the value is an ArrayBuffer or a SharedArrayBuffer, or false otherwise.

Category

Binary Data Structures

Examples

import { isArrayBufferLike } from "jsr:@nick/is/any-array-buffer";

const buffer = new ArrayBuffer(8);
const shared = new SharedArrayBuffer(8);
const array = new Uint8Array(buffer);

isArrayBufferLike(buffer); // true
isArrayBufferLike(shared); // true
isArrayBufferLike(array); // false
isArrayBufferLike(array.buffer); // true

ArrayBufferLike

Signature

export type ArrayBufferLike = ArrayBuffer | SharedArrayBuffer;

Represents an "ArrayBuffer-like" value, which is either an ArrayBuffer or SharedArrayBuffer instance.

Category

Binary Data Structures