Tell split-string not to split inside any of the quote characters specified on the quotes option. Each character signifies both the "opening" and "closing" character to use.
// default behaviorconsole.log(split('a.b."c.d.e.f.g".h.i'));//=> [ 'a', 'b', '"c', 'd', 'e', 'f', 'g"', 'h', 'i' ]// with quotesconsole.log(split('a.b."c.d.e.f.g".h.i', { quotes: ['"'] }));//=> [ 'a', 'b', '"c.d.e.f.g"', 'h', 'i' ]// escaped quotes will be ignoredconsole.log(split('a.b.\\"c.d."e.f.g".h.i', { quotes: ['"'] }));//=> [ 'a', 'b', '"c', 'd', '"e.f.g"', 'h', 'i' ]// example of how to exclude non-escaped quotes from the resultlet keep = (value, state) => { return value !== '\\' && (value !== '"' ||
Options
options.brackets
Type: Object|Boolean
Default: {}
Description
By default, no special significance is given to bracket-like characters (such as square brackets, curly braces, angle brackets, and so on).
Alternatively, an object of brackets may be passed, where each key is the opening bracket and each value is the corresponding closing bracket. Note that the key and value must be different characters. If you want to use the same character for both open and close, use the quotes option.
Examples
// no bracket support by defaultconsole.log(split('a.{b.c}.[d.e].f'));//=> [ 'a', '{b', 'c}', '[d', 'e]', 'f' ]// tell split-string not to split inside curly bracesconsole.log(split('a.{b.c}.[d.e].f', { brackets: { '{': '}' }}));//=> [ 'a', '{b.c}', '[d', 'e]', 'f' ]// tell split-string not to split inside any of these types: "<>{}[]()"console.log(split('a.{b.c}.[d.e].f', { brackets: true }));//=> [ 'a', '{b.c}', '[d.e]', 'f' ]// ...nested brackets are also supportedconsole.log(split('a.{b.{c.d}.e}.f', { brackets: true }));//=> [ 'a', '{b.{c.d}.e}', 'f' ]// tell split-string not to split inside the given custom types
options.keep
Type: function
Default: Function that returns true if the character is not \\.
Function that returns true when a character should be retained in the result.
Optionally pass a function as the last argument to tell split-string whether or not to split when the specified separator is encountered.
Example
// only split on "." when the "previous" character is "a"console.log(split('a.b.c.a.d.e', state => state.prev() === 'a'));//=> [ 'a', 'b.c.a', 'd.e' ]
The state object exposes the following properties:
input - (String) The un-modified, user-defined input string
separator - (String) the specified separator to split on.
index - (Number) The current cursor position
value - (String) The character at the current index
bos - (Function) Returns true if position is at the beginning-of-string
eos - (Function) Returns true if position is at the end-of-string
prev - (Function) Returns the previously scanned character
next - (Function) Returns the next character after the current position
block - (Object) The "current" AST node.
stack - (Array) AST nodes
About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
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
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: