string-split

A curried `String.prototype.split` with support for splitting by String, RegExp, or Function.

Usage no npm install needed!

<script type="module">
  import stringSplit from 'https://cdn.skypack.dev/string-split';
</script>

README

string-split

A curried String.prototype.split with support for splitting by String, RegExp, or Function.

Build Status Code Climate js-standard-style

npm install string-split --save
npm stats

npm NPM downloads Dependency Status

Examples

require
var split = require('string-split');
full application
split(".", "example.com");
//=> ["example", "com"]
partial application
var undot = split('.')
undot('example.com');
//=> ["example", "com"]
iteratee
var transform = split("::");
var foodtypes = ["Entree::Seafood", "Entree::Chicken"];

foodtypes.map(transform);
//=> [ ["Entree", "Seafood"], ["Entree", "Chicken"] ]
predicate
function isNumber (chr, _) {
  return !!Number(chr)
}

split(isNumber, 'Hello1World2')
//=> ['Hello', 'World']
predicate using index
function odd (chr, idx) {
  return idx % 2 !== 0
}

split(odd, 'AaBbCcDd')
//=> ['A', 'B', 'C', 'D']

Features

  • Supports splitting by String, RegExp, or Function.
  • Curried.

API

split(splitBy, string)

arguments
  • splitBy: (String|RegExp|Function) String, RegExp, or Function to split by.
  • string: (String) String to split.
returns
  • (Array) List of split string parts.
splitBy function signature

Return true to split by current chr or idx.

  • chr: (String) current character.
  • idx: (Number) current character index.

License

GitHub license