Logo for jsDocs.io

isbinaryfile

  • Version 6.0.0
  • Published
  • 20.1 kB
  • No dependencies
  • MIT license

Install

npm i isbinaryfile
yarn add isbinaryfile
pnpm add isbinaryfile

Overview

Detects if a file is binary in Node.js. Similar to Perl's -B.

Index

Functions

Interfaces

Type Aliases

Functions

function isBinaryFile

isBinaryFile: (
    file: string | Buffer,
    options?: IsBinaryOptions
) => Promise<boolean>;

    function isBinaryFileSync

    isBinaryFileSync: (file: string | Buffer, options?: IsBinaryOptions) => boolean;

      Interfaces

      interface IsBinaryOptions

      interface IsBinaryOptions {}

      • Options for binary file detection.

      property encoding

      encoding?: EncodingHint;

      • Hint about expected encoding to avoid false positives.

      property size

      size?: number;

      • Size of the buffer (only used when file is a Buffer).

      Type Aliases

      type EncodingHint

      type EncodingHint =
          | 'utf-16'
          | 'utf-16le'
          | 'utf-16be'
          | 'latin1'
          | 'iso-8859-1'
          | 'cjk'
          | 'big5'
          | 'gb2312'
          | 'gbk'
          | 'euc-kr'
          | 'shift-jis';

      • Encoding hints to improve text detection accuracy for non-UTF-8 files.

      Package Files (2)

      Dependencies (0)

      No dependencies.

      Dev Dependencies (7)

      Peer Dependencies (0)

      No peer dependencies.

      Badge

      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/isbinaryfile.

      • Markdown
        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/isbinaryfile)
      • HTML
        <a href="https://www.jsdocs.io/package/isbinaryfile"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>