WebSocket connections require extensive UTF-8 validation in order to confirm 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 an
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.
npm install utf-8-validate
In all examples we assume that you've already required the mdoule as followed:
'use strict';
var isValid = require('utf-8-validate').isValidUTF8;The module exposes 1 function:
Validate if the passed in buffer contains valid UTF-8 chars.
bu.isValidUTF8(buffer);MIT