iso-base/dist/src/utils.d.ts

Isomorphic Utils

/**
 * @param {unknown} value
 * @returns {ObjectTypeName | undefined}
 */
export function getObjectType(value: unknown): ObjectTypeName | undefined;
/**
 * @template T
 * @param {ObjectTypeName} type
 */
export function isObjectOfType<T>(type: ObjectTypeName): (value: unknown) => value is T;
/**
 * Check if value is TypeArray
 *
 * @param {unknown} value
 * @returns {value is import("./types").TypedArray}
 */
export function isTypedArray(value: unknown): value is import("./types").TypedArray;
/**
 * Check if value is BufferSource
 *
 * @param {unknown} value
 * @returns {value is BufferSource}
 */
export function isBufferSource(value: unknown): value is BufferSource;
/**
 * Check if value is Uint8Array
 *
 * @param {unknown} value
 * @returns {value is Uint8Array}
 */
export function isUint8Array(value: unknown): value is Uint8Array;
/**
 * Assert that the input is a Uint8Array.
 *
 * @param {unknown} value The value to check.
 * @throws {TypeError} If value is not a Uint8Array.
 * @returns {void}
 */
export function assertUint8Array(value: unknown): void;
/**
 * Cast typedarray to Uint8Array
 *
 * @param {ArrayBuffer | Int8Array | Uint8ClampedArray | Uint8Array | Uint16Array | Int16Array | Uint32Array | Int32Array } arr
 */
export function u8(arr: ArrayBuffer | Int8Array | Uint8ClampedArray | Uint8Array | Uint16Array | Int16Array | Uint32Array | Int32Array): Uint8Array<ArrayBufferLike>;
/**
 * Cast TypedArray to Buffer
 *
 * @param {BufferSource | string} arr
 * @param {BufferEncoding} [encoding]
 */
export function buf(arr: BufferSource | string, encoding?: BufferEncoding): Buffer<ArrayBuffer>;
/**
 * Returns a new Uint8Array created by concatenating the passed ArrayLikes
 *
 * @param {Array<ArrayLike<number>>} arrays
 * @param {number} [length]
 */
export function concat(arrays: Array<ArrayLike<number>>, length?: number): Uint8Array<ArrayBuffer>;
/**
 * Checks if two Uint8Arrays are equal
 *
 * @param {Uint8Array} aa
 * @param {Uint8Array} bb
 */
export function equals(aa: Uint8Array, bb: Uint8Array): boolean;
/**
 * Assert that the input is a string.
 *
 * @param {string} label The label to use in the error message.
 * @param {unknown} input The value to check.
 * @throws {TypeError} If input is not a string.
 * @returns {input is string}
 */
export function assertString(label: string, input: unknown): input is string;
/**
 * @type {(value: unknown) => value is ArrayBuffer}
 */
export const isArrayBuffer: (value: unknown) => value is ArrayBuffer;
export type TypedArrayTypeName = (typeof typedArrayTypeNames)[number];
export type ObjectTypeName = (typeof objectTypeNames)[number];
/**
 * Utilities to work with TypedArrays, BufferSource, and other bytes sources.
 *
 * @module
 */
declare const typedArrayTypeNames: readonly ["Int8Array", "Uint8Array", "Uint8ClampedArray", "Int16Array", "Uint16Array", "Int32Array", "Uint32Array", "Float32Array", "Float64Array", "BigInt64Array", "BigUint64Array"];
declare const objectTypeNames: readonly ["Function", "Generator", "AsyncGenerator", "GeneratorFunction", "AsyncGeneratorFunction", "AsyncFunction", "Observable", "Array", "Buffer", "Blob", "Object", "RegExp", "Date", "Error", "Map", "Set", "WeakMap", "WeakSet", "WeakRef", "ArrayBuffer", "SharedArrayBuffer", "DataView", "Promise", "URL", "FormData", "URLSearchParams", "HTMLElement", "NaN", "Int8Array", "Uint8Array", "Uint8ClampedArray", "Int16Array", "Uint16Array", "Int32Array", "Uint32Array", "Float32Array", "Float64Array", "BigInt64Array", "BigUint64Array"];
export {};
//# sourceMappingURL=utils.d.ts.map