utf8-byte-length

What is utf8-byte-length?

The utf8-byte-length npm package is designed to calculate the byte length of a string when encoded in UTF-8. This is particularly useful for applications that need to manage data sizes accurately, such as when storing or transmitting data over networks where byte size may be a constraint.

What are utf8-byte-length's main functionalities?

Calculate UTF-8 byte length

This feature allows you to calculate the byte length of a given string when encoded in UTF-8. The code sample demonstrates how to use the package to find the byte length of the string 'Hello, world!'.

const utf8ByteLength = require('utf8-byte-length');
const length = utf8ByteLength('Hello, world!');
console.log(length);

Other packages similar to utf8-byte-length

string-byte-length

Similar to utf8-byte-length, this package provides functionality to calculate the byte length of a string. It supports multiple encodings, offering a broader utility compared to utf8-byte-length which focuses solely on UTF-8.

utf8-length

This package also calculates the byte length of UTF-8 encoded strings. It is similar in functionality to utf8-byte-length but might differ in implementation details or additional minor features.

README

utf8-byte-length

Get the utf8 byte length of a string, taking into account multi-byte characters and surrogate pairs.

By default, this module defers to Buffer.byteLength. A browser implementation is also provided that doesn't use Buffer.byteLength minimize build size.

Example

var getLength = require("utf8-byte-length")
console.log(truncate("a☃", 2)) // a = 1 byte, ☃ = 3 bytes
// -> 4

API

var getLength = require("utf8-byte-length")

When using browserify or webpack, this automatically resolves to an implementation that does not use Buffer.byteLength.

getLength(string)

Returns the byte length of string. Throws an error if string is not a string.