Is Text or Binary?
Determine if a filename and/or buffer is text or binary. Smarter detection than the other solutions.
Determination works like so:
- Extension Check: If filename is available, check if any of its extensions (from right to left) are an text extension or a binary extension, this is near instant.
- Contents Check: If no filename was provided, or the extension check was indeterminate, then check the contents of the buffer.
The 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.
The 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.
One 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.
As 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.
Ever since 2012, this module's superior accuracy and performance has been essential to the operation of DocPad and its other dependents.
Usage
Complete API Documentation.
import { isText, isBinary, getEncoding } from 'istextorbinary'
or
const { isText, isBinary, getEncoding } = require('istextorbinary')
then
isText(aFilename)
isText(null, aBuffer)
isText(aFilename, aBuffer)
isText(null, null)
isBinary(aFilename)
isBinary(null, aBuffer)
isBinary(aFilename, aBuffer)
isBinary(null, null)
getEncoding(aBuffer)
Install
- Install:
npm install --save istextorbinary
- Import:
import * as pkg from ('istextorbinary')
- Require:
const pkg = require('istextorbinary')
import * as pkg from 'https://unpkg.com/istextorbinary@^9.5.0/edition-deno/index.ts'
<script type="module">
import * as pkg from '//cdn.skypack.dev/istextorbinary@^9.5.0'
</script>
<script type="module">
import * as pkg from '//unpkg.com/istextorbinary@^9.5.0'
</script>
<script type="module">
import * as pkg from '//dev.jspm.io/istextorbinary@9.5.0'
</script>
This package is published with the following editions:
istextorbinary
aliases istextorbinary/index.cjs
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-browsers/index.js
is TypeScript compiled against ES2022 for web browsers with Import for modulesistextorbinary/edition-es2022/index.js
is TypeScript compiled against ES2022 for Node.js 14 || 16 || 18 || 20 || 21 with Require for modulesistextorbinary/edition-es2017/index.js
is TypeScript compiled against ES2017 for Node.js 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modulesistextorbinary/edition-es5/index.js
is TypeScript compiled against ES5 for Node.js 4 || 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modulesistextorbinary/edition-es2017-esm/index.js
is TypeScript compiled against ES2017 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Import for modulesistextorbinary/edition-types/index.d.ts
is TypeScript compiled Types with Import for modulesistextorbinary/edition-deno/index.ts
is TypeScript source code made to be compatible with Deno
History
Discover the release history by heading on over to the HISTORY.md
file.
Backers
Code
Discover how to contribute via the CONTRIBUTING.md
file.
Authors
Maintainers
Contributors
Finances
Donors
License
Unless stated otherwise all works are:
and licensed under: