isBinaryFile

https://www.jsdocs.io/package/isbinaryfile
Admin
isBinaryFile is a Node.js library that detects whether a file is binary, similar to Perl's -B...
Tokens:922
Snippets:14
Trust Score:7.9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install isbinaryfile with npm

Source: https://www.jsdocs.io/package/isbinaryfile

Use npm to install the isbinaryfile package.

```bash
npm i isbinaryfile
```

--------------------------------

### Install isbinaryfile with yarn

Source: https://www.jsdocs.io/package/isbinaryfile

Use yarn to install the isbinaryfile package.

```bash
yarn add isbinaryfile
```

--------------------------------

### Installation

Source: https://www.jsdocs.io/package/isbinaryfile

Install the isbinaryfile package using npm, yarn, or pnpm.

```APIDOC
## Install

```bash
npm i isbinaryfile
```

```bash
yarn add isbinaryfile
```

```bash
pnpm add isbinaryfile
```
```

--------------------------------

### Install isbinaryfile with pnpm

Source: https://www.jsdocs.io/package/isbinaryfile

Use pnpm to install the isbinaryfile package.

```bash
pnpm add isbinaryfile
```

--------------------------------

### Interfaces

Source: https://www.jsdocs.io/package/isbinaryfile

API documentation for the interfaces provided by the isbinaryfile package.

```APIDOC
## Interfaces

### interface IsBinaryOptions

```typescript
interface IsBinaryOptions {}
```

- Options for binary file detection.

### property encoding

```typescript
encoding?: EncodingHint;
```

- Hint about expected encoding to avoid false positives.

### property size

```typescript
size?: number;
```

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

--------------------------------

### Overview

Source: https://www.jsdocs.io/package/isbinaryfile

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

```APIDOC
## Overview

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

--------------------------------

### Functions

Source: https://www.jsdocs.io/package/isbinaryfile

API documentation for the functions provided by the isbinaryfile package.

```APIDOC
## Functions

### function isBinaryFile

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

### function isBinaryFileSync

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

--------------------------------

### IsBinaryOptions Interface

Source: https://www.jsdocs.io/package/isbinaryfile

Interface for options that can be passed to binary file detection functions. Currently, it includes an optional encoding hint.

```typescript
interface IsBinaryOptions {}
```

--------------------------------

### Type Aliases

Source: https://www.jsdocs.io/package/isbinaryfile

API documentation for the type aliases provided by the isbinaryfile package.

```APIDOC
## Type Aliases

### type EncodingHint

```typescript
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.
```

--------------------------------

### Encoding Hint Type Alias

Source: https://www.jsdocs.io/package/isbinaryfile

Defines possible encoding hints to improve text detection accuracy for non-UTF-8 files. This is an optional parameter for binary file detection.

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

--------------------------------

### isBinaryFile Function Signature

Source: https://www.jsdocs.io/package/isbinaryfile

The asynchronous function to detect if a file is binary. It accepts a file path or a Buffer and returns a Promise resolving to a boolean.

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

--------------------------------

### jsDocs.io Badge HTML

Source: https://www.jsdocs.io/package/isbinaryfile

HTML code to embed a jsDocs.io badge linking to the package reference.

```html
<a href="https://www.jsdocs.io/package/isbinaryfile"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
```

--------------------------------

### isBinaryFileSync Function Signature

Source: https://www.jsdocs.io/package/isbinaryfile

The synchronous function to detect if a file is binary. It accepts a file path or a Buffer and returns a boolean.

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

--------------------------------

### jsDocs.io Badge Markdown

Source: https://www.jsdocs.io/package/isbinaryfile

Markdown code to embed a jsDocs.io badge linking to the package reference.

```markdown
[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/isbinaryfile)
```
Tokens:
Raw