Determines if a buffer is comprised of text or binary
JavaScript
Switch branches/tags
Latest commit 0f48feb Feb 15, 2017 @balupton balupton committed on GitHub more keywords

README.md

Is Text or Binary?

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
Slack community badge Patreon donate button Gratipay donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button

Determines if a buffer is comprised of text or binary

Install

NPM

  • Install: npm install --save istextorbinary
  • Module: require('istextorbinary')

Browserify

  • Install: npm install --save istextorbinary
  • Module: require('istextorbinary')
  • CDN URL: //wzrd.in/bundle/istextorbinary@2.1.0

Ender

  • Install: ender add istextorbinary
  • Module: require('istextorbinary')

Editions

This package is published with the following editions:

  • istextorbinary aliases istextorbinary/index.js which uses Editions to automatically select the correct edition for the consumers environment
  • istextorbinary/source/index.js is Source + ESNext + Require
  • istextorbinary/es2015/index.js is Babel Compiled + ES2015 + Require

Older environments may need Babel's Polyfill or something similar.

Usage

// Synchronous API
var result = require('istextorbinary').isTextSync(filename, buffer)

// Asynchronous API
require('istextorbinary').isText(filename, buffer, function(err, result){
  // ...
})

// You can supply text or buffer, or both text and buffer, the more provided, the more accurate the result

API Documentation.

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

No sponsors yet! Will you be the first?

Patreon donate button Gratipay donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

and licensed under: