utf8-buffer

utf8-buffer

ES6 module to encode and decode UTF-8 strings.
Copyright (c) 2018-2019 Rafael da Silva Rocha.
https://github.com/rochars/utf8-buffer

utf8-buffer is a ES6 module to encode and decode UTF-8 strings.

Install

npm install utf8-buffer

Use

Browser

Use the utf8-buffer.js file in the /dist folder:

<script src="./dist/utf8-buffer.js"></script>

Or load it from the jsDelivr CDN:

<script src="https://cdn.jsdelivr.net/npm/utf8-buffer"></script>

Or load it from unpkg:

<script src="https://unpkg.com/utf8-buffer"></script>

Node

const utf8Buffer = require('utf8-buffer');

Or import just what you need:

import {pack, unpack} from 'utf8-buffer';

About

Only UTF-8 strings with a max of 4 bytes per character are supported. BOM is kept untouched. Invalid characters are replaced with Unicode Character 'REPLACEMENT CHARACTER' (U+FFFD).

API

/**
 * Read a string of UTF-8 characters from a byte buffer.
 * Invalid characters are replaced with 'REPLACEMENT CHARACTER' (U+FFFD).
 * @see https://encoding.spec.whatwg.org/#the-encoding
 * @see https://stackoverflow.com/a/34926911
 * @param {!Uint8Array|!Array<number>} buffer A byte buffer.
 * @param {number=} start The buffer index to start reading.
 * @param {?number=} end The buffer index to stop reading.
 *   Assumes the buffer length if undefined.
 * @return {string}
 */
export function unpack(buffer, start=0, end=buffer.length) {}

/**
 * Write a string of UTF-8 characters to a byte buffer.
 * @see https://encoding.spec.whatwg.org/#utf-8-encoder
 * @param {string} str The string to pack.
 * @param {!Uint8Array|!Array<number>} buffer The buffer to pack the string to.
 * @param {number=} index The buffer index to start writing.
 * @return {number} The next index to write in the buffer.
 */
export function pack(str, buffer, index=0) {}

Contributing

utf8-buffer welcomes all contributions from anyone willing to work in good faith with other contributors and the community. No contribution is too small and all contributions are valued.

See CONTRIBUTING.md for details.

Style guide

utf8-buffer code should follow the Google JavaScript Style Guide:
https://google.github.io/styleguide/jsguide.html

Code of conduct

This project is bound by a code of conduct: The Contributor Covenant, version 1.4, also available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

LICENSE

Copyright (c) 2018-2019 Rafael da Silva Rocha.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Changelog

1.0.0 - 2019-12-31

• New package structure:
  • dist file is "./dist/utf8-buffer.js", a UMD served as "main"
  • ES6 source is "./index.js", served as "module"