is-utf8

What is is-utf8?

The is-utf8 npm package is a simple utility that allows you to check if a given buffer is valid UTF-8 encoded text. It is useful when you need to validate the encoding of text data in Node.js applications.

What are is-utf8's main functionalities?

Check if a buffer is UTF-8

This feature allows you to check if a buffer contains valid UTF-8 encoded text. The code sample demonstrates reading a file into a buffer and then using is-utf8 to check if the buffer is UTF-8.

const isUtf8 = require('is-utf8');
const fs = require('fs');

const buffer = fs.readFileSync('somefile.txt');
const isValidUtf8 = isUtf8(buffer);
console.log(isValidUtf8); // outputs true or false

Other packages similar to is-utf8

utf-8-validate

This package provides a way to check if a buffer is valid UTF-8. It is similar to is-utf8 but is specifically designed for use with WebSockets where UTF-8 validation is a common requirement.

iconv-lite

While not limited to UTF-8 validation, iconv-lite is a character encoding utility that can convert between various encodings. It can be used to check if text is UTF-8 by converting it to UTF-8 and comparing it to the original.

README

#utf8 detector

Detect if a Buffer is utf8 encoded. It need The minimum amount of bytes is 4.

    var fs = require('fs');
    var isUtf8 = require('is-utf8');
    var ansi = fs.readFileSync('ansi.txt');
    var utf8 = fs.readFileSync('utf8.txt');
    
    console.log('ansi.txt is utf8: '+isUtf8(ansi)); //false
    console.log('utf8.txt is utf8: '+isUtf8(utf8)); //true