![\"Travis](\"https://img.shields.io/travis/com/bevry/istextorbinary/master.svg\")
\n![\"NPM](\"https://img.shields.io/npm/v/istextorbinary.svg\")
\n![\"NPM](\"https://img.shields.io/npm/dm/istextorbinary.svg\")
\n![\"Dependency](\"https://img.shields.io/david/bevry/istextorbinary.svg\")
\n![\"Dev](\"https://img.shields.io/david/dev/bevry/istextorbinary.svg\")
\n![\"GitHub](\"https://img.shields.io/badge/github-donate-yellow.svg\"){kind=icon}
\n![\"Patreon](\"https://img.shields.io/badge/patreon-donate-yellow.svg\"){kind=icon}
\n![\"Flattr](\"https://img.shields.io/badge/flattr-donate-yellow.svg\"){kind=icon}
\n![\"Liberapay](\"https://img.shields.io/badge/liberapay-donate-yellow.svg\"){kind=icon}
\n![\"Buy](\"https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg\"){kind=icon}
\n![\"Open](\"https://img.shields.io/badge/open%20collective-donate-yellow.svg\"){kind=icon}
\n![\"crypto](\"https://img.shields.io/badge/crypto-donate-yellow.svg\"){kind=icon}
\n![\"PayPal](\"https://img.shields.io/badge/paypal-donate-yellow.svg\"){kind=icon}
\n![\"Wishlist](\"https://img.shields.io/badge/wishlist-donate-yellow.svg\"){kind=icon}
\n\n\n\n\n\n\nDetermine if a filename and/or buffer is text or binary. Smarter detection than the other solutions.\n\n\n\n\nDetermination works like so:\n\n1. Extension Check: If filename is available, check if any of its extensions (from right to left) are an [text extension](https://github.com/bevry/textextensions) or a [binary extension](https://github.com/bevry/binaryextensions), this is near instant.\n2. Contents Check: If no filename was provided, or the extension check was indeterminate, then check the contents of the buffer.\n\nThe extension check will check each of the filename's extensions, from right to left. This is done as certain applications utilise multiple extensions for transformations, such as `app.x.y` may tell a compiler to transform from `x` format to `y` format, in this case perhaps `x` is not a recognized extension but `y` is, in which case we can make use of that to provide superior accuracy and convenience compared to just checking the rightmost extension.\n\nThe contents check (with the default options) will check 24 bytes at the start, middle, and end of the buffer. History has shown that checking all three locations is mandatory for accuracy, and that anything less is not accurate. This technique offers superior performance while still offering superior accuracy. Alternatives generally just do 1000 bytes at the start, which is slower, and inaccurate.\n\nOne cannot just do the contents check alone because UTF16 characters are indistinguishable from binary which would return an inaccurate result, hence why the combination is necessary for accuracy, with performance for known extensions a side-effect.\n\nAs such, this library's combination of extension check (if filename is provided), then contents check (if buffer is provided), offers superior performance and accuracy to alternatives.\n\nEver since 2012, this module's superior accuracy and performance has been essential to the operation of [DocPad](https://docpad.org) and its other dependents.\n\n## Usage\n\n[Complete API Documentation.](http://master.istextorbinary.bevry.surge.sh/docs/globals.html)\n\n```typescript\nimport { isText, isBinary, getEncoding } from 'istextorbinary'\n```\n\nor\n\n```javascript\nconst { isText, isBinary, getEncoding } = require('istextorbinary')\n```\n\nthen\n\n```javascript\nisText(aFilename) // returns true if a text file otherwise false, checks only filename\nisText(null, aBuffer) // returns true if a text file otherwise false, checks only buffer\nisText(aFilename, aBuffer) // returns true if a text file otherwise false, checks filename then buffer\nisText(null, null) // returns null\n\nisBinary(aFilename) // returns true if a binary file otherwise false, checks only filename\nisBinary(null, aBuffer) // returns true if a binary file otherwise false, checks only buffer\nisBinary(aFilename, aBuffer) // returns true if a binary file otherwise false, checks filename then buffer\nisBinary(null, null) // returns null\n\ngetEncoding(aBuffer) // returns 'binary' if it contained non-utf8 characters, otherwise returns 'utf8'\n```\n\n\n\nnpm install --save istextorbinaryimport * as pkg from ('istextorbinary')const pkg = require('istextorbinary')This package is published with the following editions:
\n\nistextorbinary aliases istextorbinary/index.js which uses the Editions Autoloader to automatically select the correct edition for the consumer's environmentistextorbinary/source/index.ts is TypeScript source code with Import for modulesistextorbinary/edition-esnext/index.js is TypeScript compiled against ESNext for Node.js with Require for modulesistextorbinary/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesistextorbinary/edition-browsers/index.js is TypeScript compiled against ES2019 for web browsers with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n