| .. | ||
| index.js | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
split-string 
Split a string on a character except when the character is escaped.
Why use this?
Although it's easy to split on a string:
console.log('a.b.c'.split('.'));
//=> ['a', 'b', 'c']
It's more challenging to split a string whilst respecting escaped or quoted characters.
Bad
console.log('a\\.b.c'.split('.'));
//=> ['a\\', 'b', 'c']
console.log('"a.b.c".d'.split('.'));
//=> ['"a', 'b', 'c"', 'd']
Good
var split = require('split-string');
console.log(split('a\\.b.c'));
//=> ['a.b', 'c']
console.log(split('"a.b.c".d'));
//=> ['a.b.c', 'd']
See the options to learn how to choose the separator or retain quotes or escaping.
Install
Install with npm:
$ npm install --save split-string
Install with yarn:
$ yarn add split-string
Usage
var split = require('split-string');
split('a.b.c');
//=> ['a', 'b', 'c']
// respects escaped characters
split('a.b.c\\.d');
//=> ['a', 'b', 'c.d']
// respects double-quoted strings
split('a."b.c.d".e');
//=> ['a', 'b.c.d', 'e']
Options
options.sep
Type: String
Default: .
The separator/character to split on.
Example
split('a.b,c', {sep: ','});
//=> ['a.b', 'c']
// you can also pass the separator as string as the last argument
split('a.b,c', ',');
//=> ['a.b', 'c']
options.keepEscaping
Type: Boolean
Default: undefined
Keep backslashes in the result.
Example
split('a.b\\.c');
//=> ['a', 'b.c']
split('a.b.\\c', {keepEscaping: true});
//=> ['a', 'b\.c']
options.keepQuotes
Type: Boolean
Default: undefined
Keep single- or double-quotes in the result.
Example
split('a."b.c.d".e');
//=> ['a', 'b.c.d', 'e']
split('a."b.c.d".e', {keepQuotes: true});
//=> ['a', '"b.c.d"', 'e']
split('a.\'b.c.d\'.e', {keepQuotes: true});
//=> ['a', '\'b.c.d\'', 'e']
options.keepDoubleQuotes
Type: Boolean
Default: undefined
Keep double-quotes in the result.
Example
split('a."b.c.d".e');
//=> ['a', 'b.c.d', 'e']
split('a."b.c.d".e', {keepDoubleQuotes: true});
//=> ['a', '"b.c.d"', 'e']
options.keepSingleQuotes
Type: Boolean
Default: undefined
Keep single-quotes in the result.
Example
split('a.\'b.c.d\'.e');
//=> ['a', 'b.c.d', 'e']
split('a.\'b.c.d\'.e', {keepSingleQuotes: true});
//=> ['a', '\'b.c.d\'', 'e']
Customizer
Type: Function
Default: undefined
Pass a function as the last argument to customize how tokens are added to the array.
Example
var arr = split('a.b', function(tok) {
if (tok.arr[tok.arr.length - 1] === 'a') {
tok.split = false;
}
});
console.log(arr);
//=> ['a.b']
Properties
The tok object has the following properties:
tok.val(string) The current value about to be pushed onto the result arraytok.idx(number) the current index in the stringtok.str(string) the entire stringtok.arr(array) the result array
About
Related projects
- deromanize: Convert roman numerals to arabic numbers (useful for books, outlines, documentation, slide decks, etc) | homepage
- randomatic: Generate randomized strings of a specified length, fast. Only the length is necessary, but you… more | homepage
- repeat-string: Repeat the given string n times. Fastest implementation for repeating a string. | homepage
- romanize: Convert arabic numbers to roman numerals (useful for books, outlines, documentation, slide decks, etc) | homepage
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Contributors
| Commits | Contributor |
|---|---|
| 12 | jonschlinkert |
| 9 | doowb |
Building docs
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
Running tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
Author
Jon Schlinkert
License
Copyright © 2017, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on April 27, 2017.