utf-8-validate

What is utf-8-validate?

The utf-8-validate npm package is used to validate UTF-8 encoded data. It is primarily used to ensure that a stream of data is valid UTF-8 before processing it further. This can be particularly useful when dealing with text data in network communication or file processing where UTF-8 encoding is expected.

What are utf-8-validate's main functionalities?

Validation of UTF-8 Encoded Data

This feature allows you to validate whether a given Buffer contains valid UTF-8 encoded data. The function `isValidUTF8` returns a boolean indicating the validity of the data.

const { isValidUTF8 } = require('utf-8-validate');

const buffer = Buffer.from('valid UTF-8 string', 'utf8');
const isValid = isValidUTF8(buffer);
console.log(isValid); // true or false

Other packages similar to utf-8-validate

is-utf8

The is-utf8 package is similar to utf-8-validate as it provides a function to check if a Buffer is valid UTF-8. It is a simple and lightweight package for UTF-8 validation.

README

utf-8-validate

WebSocket connections require extensive UTF-8 validation in order to conform to the specification. This was unfortunately not possible in JavaScript, hence the need for a binary addon.

As the module consists of binary components, it should be used as optionalDependency so when installation fails, it doesn't halt the installation of your module. There are fallback files available in this repository. See fallback.js for the suggest fallback implementation if installation fails.

Installation

npm install utf-8-validate

API

In all examples we assume that you've already required the mdoule as follows:

'use strict';

var validation = require('utf-8-validate').Validation;

The module exposes 1 function:

isValidUTF8

Validate if the passed in buffer contains valid UTF-8 chars.

validation.isValidUTF8(buffer);

License

MIT