GithubHelp home page GithubHelp logo

isabella232 / split-sms Goto Github PK

View Code? Open in Web Editor NEW

This project forked from emartech/split-sms

0.0 0.0 0.0 290 KB

An SMS message splitter and part calculator with support for GSM and Unicode.

Home Page: http://www.codesleuth.co.uk/split-sms

License: MIT License

JavaScript 100.00%

split-sms's Introduction

split-sms

NPM version Build Status Bower version NPM

An SMS message splitter with support for both GSM and Unicode written in JavaScript. GSM support is limited to GSM 03.38 with the extension table (see the Wikipedia article); no support for natural language shift tables exists at this time.

View the demo...

Getting Started

  1. Install via npm: npm install split-sms
  2. Include in your project: var splitter = require('split-sms');
  3. Start splitting messages! var info = splitter.split('JavaScript is fun!');

In the example above, info will be:

{
  "characterSet": "GSM",
  "parts": [
    {
      "content": "JavaScript is fun!",
      "length": 18,
      "bytes": 18
    }
  ],
  "bytes": 18,
  "length": 18,
  "remainingInPart": 142
}

Unicode example:

splitter.split('Snowman shows off! ☃');
{
  "characterSet": "Unicode",
  "parts": [
    {
      "content": "Snowman shows off! ☃",
      "length": 20,
      "bytes": 40
    }
  ],
  "bytes": 40,
  "length": 20,
  "remainingInPart": 50
}

Options

providerReservedCharacters

This option reserves the specified number of characters in the end of the message for a provider specific id.

Usage:

splitter.split('Snowman shows off! ☃' { prodiverReservedCharacters: 5 });

In The Browser

You can use Bower to install split-sms components:

$ bower install split-sms --save

You can also use RawGit to link directly to specific versions of the built scripts. For example, the following URLs are for version 0.1.7:

Type URL
Source https://github.com/Codesleuth/split-sms/blob/0.1.7/dist/split-sms.min.js
RawGit dev https://rawgit.com/Codesleuth/split-sms/0.1.7/dist/split-sms.min.js
RawGit CDN https://cdn.rawgit.com/Codesleuth/split-sms/0.1.7/dist/split-sms.min.js

Alternatively, pull out the scripts in the dist/ directory and consume them.

To generate a browser consumable script yourself, clone the repo and run the following commands:

$ npm install
$ npm run build

This will generate the browser-compatible scripts in dist/ and export splitter to the global so you can then consume it in the browser as follows:

<html>
<head>
  <script src="split-sms.js"></script>
</head>
<body>
<script>
  var info = window.splitter.split('Hello!');
  document.write(JSON.stringify(info));
</script>
</body>

See the demo site for an example.

split-sms's People

Contributors

codesleuth avatar ifroz avatar kovndr avatar szeist avatar esendexdev avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.