# text-segmentation

> text-segmentation ==============

Latest version **1.0.3** (published 2022-01-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install text-segmentation
pnpm add text-segmentation
yarn add text-segmentation
bun add text-segmentation
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2022-01-22 |
| First published | 2021-08-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 262.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 18 |
| Author | Niklas von Hertzen |
| Maintainers | niklasvh |

## Links

- npm: https://www.npmjs.com/package/text-segmentation
- Repository: https://github.com/niklasvh/text-segmentation
- Issues: https://github.com/niklasvh/text-segmentation/issues
- npm.io page: https://npm.io/package/text-segmentation

## Dependencies (1)

- [utrie](https://npm.io/package/utrie.md) ^1.0.2

## Recent versions

- 1.0.3 (latest) — 2022-01-22
- 1.0.2 — 2021-08-10
- 1.0.1 — 2021-08-09
- 1.0.0 — 2021-08-09

## README

text-segmentation
==============

![CI](https://github.com/niklasvh/text-segmentation/workflows/CI/badge.svg?branch=main)
[![NPM Downloads](https://img.shields.io/npm/dm/text-segmentation.svg)](https://www.npmjs.org/package/text-segmentation)
[![NPM Version](https://img.shields.io/npm/v/text-segmentation.svg)](https://www.npmjs.org/package/text-segmentation)

A JavaScript library for Grapheme Breaking and identifying Grapheme Boundaries, [implementing the Unicode Line Breaking Algorithm (UAX #29)](https://unicode.org/reports/tr29/)

### Installing
You can install the module via npm:

    npm install text-segmentation
  
### Example
```javascript
import {splitGraphemes} from 'text-segmentation';

const graphemes =  splitGraphemes('Hello 👨‍👩‍👧‍👦!');
```    

### Testing
You can run the test suite with:

    npm test

The library implements all the [GraphemeBreakTest.txt tests](https://www.unicode.org/Public/13.0.0/ucd/auxiliary/GraphemeBreakTest.txt).

---
_Source: https://npm.io/package/text-segmentation · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._