spiegel-keyman/common/models/wordbreakers/README.md
Eddie Antonio Santos 3cc8ee2399
docs(common/models): Apply suggestions from code review
Co-authored-by: Marc Durdin <marc@durdin.net>
2020-05-19 15:30:43 -06:00

549 B

@keymanapp/models-wordbreakers

The word breakers bundled in Keyman's modeling layer (common/models).

Includes:

  • default — a word breaker based on the Unicode default word boundary specification
  • deprecated ascii — an example word breaker
  • deprecated placeholder — an example word breaker

Usage

import {wordBreakers} from '@keymanapp/models-wordbreakers';
const breakWords = wordBreakers['default'];

console.log(breakWords('Hello, World!').map(span => span.text));
// prints: [ 'Hello', ',', 'World', '!' ]