npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

segmenter

v2.0.1

Published

Work with grapheme, words, and sentences with small, simple, and fast API using Intl.Segmenter

Downloads

22

Readme

segmenter

Work with grapheme, words, and sentences with small, simple, and fast API using Intl.Segmenter

Gzipped Size Build Status

Install

npm install segmenter

Why

  • Intl.Segmenter is supported in all major browsers and 94% of users have it available — it's time for adoption.
  • If you have a use case other than iterating over all graphemes/words/sentences in a text, then Intl.Segmenter might be a little hard to work with.
  • In many cases, working with graphemes is preferable to characters. Graphemes are what the end user sees. For example, the emoji 👨‍🔧️ is a single grapheme but consists of 6 characters. for loop will make 6 iterations, for of looping 👨‍🔧️ will make 4 iterations — it's confusing, just use graphemes.
  • Before Intl.Segmenter, working with graphemes required libraries like graphemer that is 94KB in size.

Usage

import { graphemeAt, graphemeRangeAt, wordAt, wordRangeAt } from "segmenter";

graphemeAt("👨‍🔧️ the fixer", 3); // 👨‍🔧️

graphemeRangeAt("👨‍🔧️ the fixer", 3); // { start: 0, end: 6 }

wordAt("hello-world"); // "hello"

wordRangeAt("hello-world"); // { start: 0, end: 5 }

API

Graphemes

graphemeAt(string: string, position: number): string | undefined

Get the grapheme at position in string. Returns undefined if position is out of bounds or string is empty.

graphemeRangeAt(string: string, position: number): { start: number; end: number; } | undefined

Get the start and end positions of the grapheme at position in string. Returns undefined if position is out of bounds or string is empty.

graphemes(string: string): string[]

Get all graphemes in the string as Array.

Words

wordAt(string: string, position: number): string | undefined

Get the word at position in string. Returns undefined if position is out of bounds or string is empty.

wordRangeAt(string: string, position: number): { start: number; end: number; } | undefined

Get the start and end positions of the word at position in string. Returns undefined if position is out of bounds or string is empty.

words(string: string): string[]

Get all words in the string as Array.

Sentences

Note: Intl.Segmenter doesn't do a perfect job of detecting sentences. For example, I went to Dr. Smith's office will be split into two sentences.

sentenceAt(string: string, position: number): string | undefined

Get the sentence at position in string. Returns undefined if position is out of bounds or string is empty.

sentenceRangeAt(string: string, position: number): { start: number; end: number; } | undefined

Get the start and end positions of the sentence at position in string. Returns undefined if position is out of bounds or string is empty.

sentences(string: string): string[]

Get all sentences in the string as Array.