Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonschlinkert/is-binary-buffer
Returns true if a buffer is binary. Takes a buffer and does not read from the file system.
https://github.com/jonschlinkert/is-binary-buffer
binary buffer check is javascript nodejs string
Last synced: about 2 months ago
JSON representation
Returns true if a buffer is binary. Takes a buffer and does not read from the file system.
- Host: GitHub
- URL: https://github.com/jonschlinkert/is-binary-buffer
- Owner: jonschlinkert
- License: mit
- Created: 2017-05-19T20:36:35.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-03-07T12:13:33.000Z (almost 7 years ago)
- Last Synced: 2024-11-02T14:51:54.261Z (2 months ago)
- Topics: binary, buffer, check, is, javascript, nodejs, string
- Language: JavaScript
- Homepage: https://github.com/jonschlinkert
- Size: 17.6 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# is-binary-buffer [](https://www.npmjs.com/package/is-binary-buffer) [](https://npmjs.org/package/is-binary-buffer) [](https://npmjs.org/package/is-binary-buffer) [](https://travis-ci.org/jonschlinkert/is-binary-buffer)
> Returns true if a buffer is binary. Takes a buffer and does not read from the file system.
Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save is-binary-buffer
```
## What is this?
This a node.js library written in pure javascript that can be used to check if the given value is a "binary buffer".
## Usage
You can add this library to your node.js application using node's `require()` system with the following line of code:
```js
var fs = require('fs');
var isBinary = require('is-binary-buffer');
console.log(isBinary('foo'));
console.log(isBinary(new Buffer('foo')));
//=> false
console.log(isBinary(fs.readFileSync('some-image.jpg')));
console.log(isBinary(fs.readFileSync('some-image.gif')));
//=> true
```
## Attribution
Based on the code from [isbinaryfile](https://github.com/gjtorikian/isBinaryFile), which only reads from the file system. If the file doesn't exist, is a directory, or is empty, the function returns false.
[isbinaryfile is MIT Licensed](https://github.com/gjtorikian/isBinaryFile/blob/b808cba3faa824bd3cade089743a714187af7193/LICENSE.txt)
## About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Please read the [contributing guide](.github/contributing.md) for advice on opening issues, pull requests, and coding standards.
Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
```sh
$ npm install && npm test
```
Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Author
**Jon Schlinkert**
* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
* [GitHub Profile](https://github.com/jonschlinkert)
* [Twitter Profile](https://twitter.com/jonschlinkert)
### License
Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on March 07, 2018._