aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 12 insertions, 6 deletions
diff --git a/README.md b/README.md
index bc3b297..c89525d 100644
--- a/README.md
+++ b/README.md
@@ -5,25 +5,31 @@ Regular expression-like syntax for list operations. You didn't ask for this so h
Example -
```js
-filter(/ \T (\s | \n) /, [ null, 0, '2', 3, true ]) // > [ '2', 3 ]
+filter(/ \T (\s | \n) /, [ null, 0, '2', 3, true ])
+// > [ '2', 3 ]
-filter(/ \T[name \s\T] /, [ null, 0, { name: '' }, { name: 'phenax' } ]) // > [ { name: 'phenax' } ]
+filter(/ \T[name \s\T] /, [ null, 0, { name: '' }, { name: 'phenax' } ])
+// > [ { name: 'phenax' } ]
+
+matchAll(/ [num \n\T]+ /, [ null, { num: 1 }, { num: 2 }, {}, { num: 0 }, { num: 3 } ])
+// > [ { value: [{ num: 1 }, { num: 2 }], index: 1 }, { value: [{ num: 3 }], index: 5 } ]
```
### Syntax
-Whitespaces are ignore (exceptions: within string literals and nested regex)
+Whitespaces are ignore (except within literals)
* `\s` => Any string
* `\n` => Any number
* `\b` => Any boolean
* `\T` => Any truthy value
* `\F` => Any falsey value
-* `a|b` => match `a` **or** `b`
+* `a|b` => match `a` **or** `b` [TODO]
* `a*` => Zero or more consecutive instances of pattern `a` in the list
* `a+` => One or more consecutive instances of pattern `a` in the list
* `(\s\T)` => Group (example matches any non-empty string)
-* `^a$` => `^` indicates start of list, and `$` indicates end of list
-* `a,b` => match `a` followed by `b` (next item)
+* `^a$` => `^` indicates start of list, and `$` indicates end of list [TODO]
+* `a,b` => match `a` followed by `b` (next item) [TODO]
* `[name \s\T]` => match property of object (example matches items with property `name` as non-empty string)
+* `> n` | `>= n` | `< n` | `<= n` => Comparison [TODO]