import { isBinaryFile, isBinaryFileSync } from 'isbinaryfile';import fs from 'fs';const filename = 'fixtures/pdf.pdf';// Async with file pathconst result = await isBinaryFile(filename);if (result) { console.log('It is binary!');} else { console.log('No it is not.');}// Sync with bufferconst bytes = fs.readFileSync(filename);console.log(isBinaryFileSync(bytes)); // true or false// With explicit size option
Encoding Hints
For files that use non-UTF-8 encodings, you can provide encoding hints to improve detection accuracy:
import { isBinaryFile, isBinaryFileSync } from 'isbinaryfile';// UTF-16 files without BOM are auto-detected in most casesconst result1 = await isBinaryFile('utf16-file.txt');// Or provide explicit encoding hintconst result2 = await isBinaryFile('utf16-file.txt', { encoding: 'utf-16' });// ISO-8859-1 / Latin-1 encoded filesconst result3 = isBinaryFileSync('german-text.txt', { encoding: 'latin1' });// CJK encoded files (Big5, GB2312, EUC-KR, etc.)const result4 = isBinaryFileSync('chinese-big5.txt', { encoding: 'big5' });const result5 = isBinaryFileSync('korean-text.txt'
Supported Encoding Hints
Hint
Description
utf-16
UTF-16 (auto-detect endianness)
utf-16le
UTF-16 Little Endian
utf-16be
UTF-16 Big Endian
latin1
ISO-8859-1 / Latin-1
iso-8859-1
Alias for latin1
cjk
Generic CJK (use when encoding is unknown)
big5
Traditional Chinese
gb2312
Simplified Chinese
gbk
Extended GB2312
euc-kr
Korean
Note: UTF-16 without BOM is automatically detected in most cases without needing a hint.