UNPKG

1.5 kBMarkdownView Raw
1# is-buffer [![travis][travis-image]][travis-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][npm-url]
2
3#### Determine if an object is a [`Buffer`](http://nodejs.org/api/buffer.html) (including the [browserify Buffer](https://github.com/feross/buffer))
4
5[![saucelabs][saucelabs-image]][saucelabs-url]
6
7[travis-image]: https://img.shields.io/travis/feross/is-buffer/master.svg
8[travis-url]: https://travis-ci.org/feross/is-buffer
9[npm-image]: https://img.shields.io/npm/v/is-buffer.svg
10[npm-url]: https://npmjs.org/package/is-buffer
11[downloads-image]: https://img.shields.io/npm/dm/is-buffer.svg
12[saucelabs-image]: https://saucelabs.com/browser-matrix/is-buffer.svg
13[saucelabs-url]: https://saucelabs.com/u/is-buffer
14
15## Why not use `Buffer.isBuffer`?
16
17This module lets you check if an object is a `Buffer` without using `Buffer.isBuffer` (which includes the whole [buffer](https://github.com/feross/buffer) module in [browserify](http://browserify.org/)).
18
19It's future-proof and works in node too!
20
21## install
22
23```bash
24npm install is-buffer
25```
26
27## usage
28
29```js
30var isBuffer = require('is-buffer')
31
32isBuffer(new Buffer(4)) // true
33
34isBuffer(undefined) // false
35isBuffer(null) // false
36isBuffer('') // false
37isBuffer(true) // false
38isBuffer(false) // false
39isBuffer(0) // false
40isBuffer(1) // false
41isBuffer(1.0) // false
42isBuffer('string') // false
43isBuffer({}) // false
44isBuffer(function foo () {}) // false
45```
46
47## license
48
49MIT. Copyright (C) [Feross Aboukhadijeh](http://feross.org).