UNPKG

clean-split

Version:

Cleanly split a string by retaining the delimiter.

Richienb/clean-split

54 lines (31 loc) • 1.05 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# Clean Split [![Travis CI Build Status](https://img.shields.io/travis/com/Richienb/clean-split/master.svg?style=for-the-badge)](https://travis-ci.com/Richienb/clean-split) Cleanly split a string by retaining the delimiter. [![NPM Badge](https://nodei.co/npm/clean-split.png)](https://npmjs.com/package/clean-split) ## Install ```sh npm install clean-split ``` ## Usage ```js const cleanSplit = require("clean-split"); cleanSplit("a-b-c", "-"); //=> ["a", "-", "b", "-", "c"] cleanSplit("a-b-c", "-", { anchor: "before" }); //=> ["a-", "b-", "c"] cleanSplit("a-b-c", "-", { anchor: "after" }); //=> ["a", "-b", "-c"] ``` ## API ### cleanSplit(string, delimiter, options?) #### string Type: `string` The string to split. #### delimiter Type: `string or regexp` The delimiter to split the string by. #### options Type: `object` ##### anchor Type: `string` (`none`, `before`, `after`, `left` or `right`)\ Default: `none` Anchor the delimiter to different sides of the split.