1.0.1 • Published 8 years ago
split-retain v1.0.1
split-retain
Split a string and preserve the delimiters.
Install
Node.jsnpm install split-retain --save
var splitRetain = require('split-retain');
Browser
Include the full or minified version on your webpage from browser/, then use splitRetain(...).
<script src="path/to/split-retain.min.js">
Examples
splitRetain('home/jack/images/photo12.jpeg', '/')
// ['home/', 'jack/', 'images/', 'photo12.jpeg']
splitRetain('home/jack/images/photo12.jpeg', '/', { leadingSeparator: true })
// ['home', '/jack', '/images', '/photo12.jpeg']
...Documentation
splitRetain(string, separator[, options])
Arguments
| argument | type | desription |
|---|---|---|
| string | String | string to split |
| separator | String———RegExp | single character———must have grouping parentheses and global flag, e.g. /(\d+)/g |
options = {} | Object | - |
options.leadingSeparator = false | Boolean | if true, the separator will be placed at the beginning of the split tokens |
Results
| property | type | description |
|---|---|---|
| @return | String[] | array of split tokens |
| @throws | Error | on incorrect argument types |
Tests
npm test
Coverage
npm run cover
TODO
- create 'publish steps'
- replace browserify with UMD?
- more examples in Examples
- changelog
- lint
- ...
License
MIT