Skip to main content

isBuffer()

isBuffer(value): value is Buffer<ArrayBufferLike>

Checks if value is a Buffer (Node.js only).

DEPRECATED

Use Buffer.isBuffer() directly instead (Node.js only).


Parametersโ€‹

value: unknownโ€‹

The value to check.


Returns: value is Buffer<ArrayBufferLike>โ€‹

true if value is a Buffer, else false.


See Alsoโ€‹

Buffer.isBuffer() - Node.js


Sinceโ€‹

2.0.0


Also known asโ€‹

isBuffer (Lodash, es-toolkit) ยท โŒ (Remeda, Radashi, Ramda, Effect, Modern Dash, Antfu)


Exampleโ€‹

// โŒ Deprecated approach
isBuffer(Buffer.from('hello')); // => true
isBuffer(new Uint8Array(2)); // => false

// โœ… Recommended approach (Node.js)
Buffer.isBuffer(Buffer.from('hello')); // => true
Buffer.isBuffer(new Uint8Array(2)); // => false

How it works?โ€‹

Checks if value is a buffer. Deprecated: Use Buffer.isBuffer() directly in Node.js.

Native Equivalentโ€‹

// โŒ isBuffer(value)
// โœ… Buffer.isBuffer(value)

Use Casesโ€‹

Check buffer type ๐Ÿ“Œโ€‹

Check for binary data types.

value instanceof ArrayBuffer;
value instanceof Uint8Array;
ArrayBuffer.isView(value);

Validate binary dataโ€‹

Verify value is a typed array.

if (value instanceof Uint8Array) {
processBinary(value);
}

Check any typed arrayโ€‹

Check for any TypedArray.

ArrayBuffer.isView(value) && !(value instanceof DataView);