~exprez135/taliaferro

ref: 8b6e0f7c019f532841af40b950c4048422232234 taliaferro/node_modules/is-binary-buffer/README.md -rw-r--r-- 2.9 KiB
8b6e0f7c — Nate rebuilding site Sun Feb 9 13:47:19 CST 2020: Fix navbar symbols showing up first. 1 year, 11 months ago

#is-binary-buffer NPM version NPM monthly downloads NPM total downloads Linux Build Status

Returns true if a buffer is binary. Takes a buffer and does not read from the file system.

#Install

Install with npm:

$ 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:

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, 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

#About

#Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

#Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

#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:

$ npm install && npm test

#Author

Jon Schlinkert

#License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.6.0, on May 19, 2017.