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

polly-text-split

v0.1.4

Published

Text splitter for working with AWS Polly TTS.

Downloads

470

Readme

Polly Text Splitter

Build Status Coverage Status code style: prettier License: MIT

Synopsis

Adaptively split plain text by batches with size of <=1500 characters each to overcome AWS Polly TTS input limitations. By default, this utility splits text by the nearest dot (.) or if no dot found - it searches for other characters, that we can set by our own or use the defaults.

Motivation

When you use method synthesizeSpeech() of AWS Polly TTS SDK you cannot pass more than 1500 character at a time. If you have a long text, it can become tedious to manually split it at the right positions. This little library solves this problem by splitting your text by batches suitable for Polly input.

Also, given that the AWS Polly is a context aware text-to-speech system, it adjusts speech pronunciation and accents based on punctuation too. So this library tries to keep speech natural by splitting only at the right places:

  1. at the nearest dot .
  2. if (1) not found - split by , or ; (by default, can be configured)
  3. if (2) not found - split by space ``
  4. if (3) not found - hard split at the HARD_LIMIT index

Installation

npm install polly-text-split

Code Example

Basic usage

const pollyTextSplit = require('polly-text-split')

// 1. Method split() returns array of strings.
const batches = pollyTextSplit.split('your long text here')

// 2. Method splitIndex() returns index of the possible split position.
const splitIndex = pollyTextSplit.splitIndex('your long text here')
// So you can split manually using native string method
const batch = 'your long text here'.slice(0, splitIndex + 1)

Configuration

By default, configuration is not necessary, but if you need to set your own limits or split characters, you can use method configure() for that.

const pollyTextSplit = require('polly-text-split')

// Configuration example with default values
const options = {
    // MIN length of a single batch of split text
    softLimit: 1000,
    // MAX length of a single batch of split text
    hardLimit: 1500,
    // Set of extra split characters (Optional property)
    extraSplitChars: ',;',
}

// Apply configuration
pollyTextSplit.configure(options)

// Use with new configuration
const batches = pollyTextSplit.split('your long text here')

API documentation

Tests

npm test

Contributors

Any contributions are very welcome.

License

MIT.

Changelog

[0.1.4] - 2018-04-23

  • Hide private properties from user API.

[0.1.3] - 2018-04-13

  • Update JSDoc annotations.

[0.1.2] - 2018-04-13

  • Code refactor and optimizations.

[0.1.1] - 2018-04-10

  • Add Readme.

[0.1.0] - 2018-04-10

  • Initial release.