Skip to content

Latest commit

 

History

History
43 lines (23 loc) · 1.97 KB

README.md

File metadata and controls

43 lines (23 loc) · 1.97 KB
Raw

Unicode position conversion

This is a super simple no-deps conversion tool to convert between unicode codepoint offsets and JS string offsets.

This module exposes 2 methods:

strPosToUni(s: string, strOffset?: number)

Convert from a JS string position to a unicode position.

For example, given the JS string '💃123', JS string position 2 is right after the 💃. Since that emoji is a single code point wide, the unicode equivalent of that position is 1.

const {strPosToUni} = require('unicount')

console.log(strPosToUni('💃123', 2)) // 1

The offset is optional. If it is missing, it defaults to the length of the string (so bare strPosToUni(str) returns the number of unicode code points in the given string).

uniToStrPos(s: string, uniOffset: number)

Convert a unicode codepoint position to a string offset position

This function does the inverse of strPosToUni. Given a string s and a number of codepoints uniOffset, this returns the string position right after specified number of unicode codepoints.

const {uniToStrPos} = require('unicount')

uniToStrPos.uniToStrPos('💃123', 1) // 2

Unlike strPosToUni, the second offset argument is not optional. Call s.length to discover the JS string length.

LICENSE

Copyright 2019 Joseph Gentle

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.