Skip to content

Commit ef8c823

Browse files
committed
document arguments
1 parent 09d3ab7 commit ef8c823

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,26 @@ pull(
3333
)
3434
```
3535

36+
## split(matcher, mapper, reverse, skipLast)
37+
38+
### matcher - string or regexp.
39+
40+
unit to split by, defaults to `\n`
41+
42+
### mapper - function
43+
44+
function to apply to each line matched.
45+
46+
### reverse - boolean
47+
48+
if true, emit lines in reverse. use this if the input is a file
49+
you are reading backwards.
50+
51+
### skipLast - boolean
52+
53+
use this to skip the last value if it is and empty string `''`
54+
if this is not set then the behavior is the same as `String#split`
55+
3656
## License
3757

3858
MIT

0 commit comments

Comments
 (0)