www.aleph1.co.uk Git - yaffs-website/blob - node_modules/is-buffer/README.md

   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
  17 This 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
  19 It's future-proof and works in node too!
  20
  21 ## install
  22
  23 ```bash
  24 npm install is-buffer
  25 ```
  26
  27 ## usage
  28
  29 ```js
  30 var isBuffer = require('is-buffer')
  31
  32 isBuffer(new Buffer(4)) // true
  33
  34 isBuffer(undefined) // false
  35 isBuffer(null) // false
  36 isBuffer('') // false
  37 isBuffer(true) // false
  38 isBuffer(false) // false
  39 isBuffer(0) // false
  40 isBuffer(1) // false
  41 isBuffer(1.0) // false
  42 isBuffer('string') // false
  43 isBuffer({}) // false
  44 isBuffer(function foo () {}) // false
  45 ```
  46
  47 ## license
  48
  49 MIT. Copyright (C) [Feross Aboukhadijeh](http://feross.org).