You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Thomas Rory Gummerson 18cf5df5f3 npmignore 2 months ago
.npmignore npmignore 2 months ago
README.md Simple RegExp support, heredoc support 2 months ago
bracketSplit.js Browser version 4 months ago
browserify.bat Browser version 4 months ago
browserify.sh Browser version 4 months ago
index.js Simple RegExp support, heredoc support 2 months ago
package.json 1.1.5 2 months ago
test.js Simple RegExp support, heredoc support 2 months ago

README.md

bracket-split

This module can do bracket-aware splitting of strings!

Example:

const bracketSplit = require('bracket-split');

bracketSplit(
	' ',
	'{ "status": "ok" } [ "status" ] 2 3')
//-> [ '{ "status": "ok" }', '[ "status" ]', '2', '3' ]

Options

bracketSplit(
	delimiter,
	str,
	brackets = [ [ '{', '}' ], [ '[', ']' ] ],
	quotes = [ '\'', '"' ],
	escaper = '\\'
)

delimiter and str work as if you did str.split(delimiter)

brackets are pairs of brackets to treat specially, these will be checked for maching pairs in the str you are splitting, and errors may be thrown!

quotes are quote characters, brackets will be ignored if they are quoted (treated as plain strings)

escaper is a string to prefix another character in order to always treat it as a normal character (you can escape quotes and brackets to ignore them)

heredocs are pairs of brackets to treat as special overriding unnestable brackets, they support escaping and work a bit differently from normal brackets

Possible errors

Unexpected closing bracket: <closing bracket>
Unexpected end of input, expected: <quote or closing bracket>