utf8-buffer-size

Copyright (c) 2018 Rafael da Silva Rocha.
https://github.com/rochars/utf8-buffer-size

Return how many bytes are needed to serialize a UTF-8 string.

• No dependencies
• MIT licensed
• Use it out of the box in the browser
• Use it out of the box in Node
• Use it out of the box with TypeScript
• Less than 1KB!

Install

npm install utf8-buffer-size

You can also download the UMD dist file in the ./dist folder:
https://github.com/rochars/utf8-buffer-size/tree/master/dist

Use

Node

If you installed via NPM or Yarn, import utf8BufferSize from utf8-buffer-size:

import utf8BufferSize from 'utf8-buffer-size';
let bufferSize = utf8BufferSize('Some string');

Or require:

const utf8BufferSize = require('utf8-buffer-size');
let bufferSize = utf8BufferSize('輸輸笠߹~$輸abcd');

Browser

Use the compiled file in the /dist folder of this package:

<script src="./dist/utf8-buffer-size.umd.js"></script>
<script>
  var bufferSize = utf8BufferSize('輸輸笠߹~$輸abcd');
</script>

Or get it from the jsDelivr CDN:

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

Or get it from unpkg:

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

Or load it as a module using jspm:

<script type="module">
  import utf8BufferSize from 'https://dev.jspm.io/utf8-buffer-size';
  let bufferSize = utf8BufferSize('輸輸笠߹~$輸abcd');
</script>

API

/**
 * Returns how many bytes are needed to serialize a UTF-8 string.
 * @see https://encoding.spec.whatwg.org/#utf-8-encoder
 * @param {string} str The string to pack.
 * @return {number} The number of bytes needed to serialize the string.
 */
export default function utf8BufferSize(str) {}

Distribution

This library is a ES module also distributed as a UMD module. It works out of the box in Node when installed with npm install utf8-buffer-size. It includes a TypeScript definition file: ./main.d.ts.

If you are using this lib in a browser:

You can load ./dist/utf8-buffer-size.umd.js in the browser with <script> tags. You can load it via the https://unpkg.com and https://www.jsdelivr.com/ CDNs:

unpkg:

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

jsDelivr:

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

Contributing

utf8-buffer-size 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.

Style guide

utf8-buffer-size 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, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting [email protected].

LICENSE

Copyright (c) 2018 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.