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

@loltech/sms-splitter

v1.0.2

Published

Typescript library for splitting strings into SMS messages according to GSM-7 or UCS-2.

Downloads

448

Readme

LOLTECH SMS Splitter

A Typescript library for splitting a message string into parts according to GSM specifications.

Installation

This package is meant for usage in Node.js. Should work in the browser when using something like webpack or rollup.

yarn add @loltech/sms-splitter

OR

npm install @loltech/sms-splitter

Usage

import { isMultipart, split } from '@loltech/sms-splitter';

Is a message multipart?

function isMultipart(message: string): boolean;

Given a message string, determines whether that string needs to be split up according to GSM spec. Return the result as a boolean.

Split the message

function split(message: string): ISplitResult | null;

Given a message string, will determine its required encoding and split it into parts according to GSM spec.

Return value

If message is anything other than a string, it returns null. If message is a string, it returns an object of the form:

interface ISplitResult {
  encoding: ENCODING;
  extended?: boolean;
  parts: string[];
}
  • encoding - Can be GSM-7, UCS-2, UTF-16. UCS-2 and UTF-16 are very similar, but UTF-16 can also encode UTF-32 characters. UCS-2 basically means the string does not use characters outside the BMP.

  • extended - Only present when encoding is GSM-7. Signals the string contains GSM-7 extended characters.

  • parts - An array of strings making up the resultant SMS parts.

Note on behaviour

When splitting SMS messages for transmission, it's best practice to not split up characters. This happens both in GSM-7 (where extended characters are actually made up of two characters) and UTF-16 (where surrogate pairs are employed). This library DOES NOT split characters. While this is technically correct, it's not the whole story. As can be seen in this particular patch comment, some carries cannot handle messages split within character boundaries. Unfortunately the only possible solution I found will be to use Intl.breakItreator, but that feature hasn't been standardized or implemented yet.