39 lines
1.4 KiB
Markdown
39 lines
1.4 KiB
Markdown
# string-split-by [](http://github.com/badges/stability-badges) [](https://travis-ci.org/dy/string-split-by)
|
|
|
|
Split string by a separator with respect to brackets, quotes and escape markers. Optimized version of [string-split](https://github.com/jonschlinkert/split-string).
|
|
|
|
## Usage
|
|
|
|
[](https://npmjs.org/package/string-split-by/)
|
|
|
|
|
|
```js
|
|
var split = require('string-split-by')
|
|
|
|
split('a."b.c".d.{.e.f.g.}.h', '.')
|
|
// ['a', '"b.c"', 'd', '{.e.f.g.}', 'h']
|
|
|
|
split('a."b.c".d.{.e.f.g.}.h', '.', {ignore: '""'})
|
|
// ['a', '"b.c"', 'd', '{', 'e', 'f', 'g', '}', 'h']
|
|
```
|
|
|
|
## API
|
|
|
|
### parts = splitBy(string, separator, options?)
|
|
|
|
Return array with parts split from string by a separator, which can be whether _String_ or _RegExp_. Options can define:
|
|
|
|
Option | Default | Meaning
|
|
---|---|---
|
|
`ignore` | ``['"', "'", '`', '“”', '«»', '[]', '()', '{}']`` | Avoid splitting content enclosed in the character pairs. Can be a string or a list of strings.
|
|
`escape` | `true` | Avoid splitting at the escaped separator, eg. `\.` won't be separated by `'.'` separator.
|
|
|
|
|
|
## Related
|
|
|
|
* [parenthesis](http://npmjs.org/package/parenthesis)
|
|
|
|
## License
|
|
|
|
© 2018 Dmitry Yv. MIT License
|