aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAkshay Nair <phenax5@gmail.com>2022-01-08 21:20:17 +0530
committerAkshay Nair <phenax5@gmail.com>2022-01-08 21:25:42 +0530
commitf9544958194efb54e2c4f211a632964c488456e8 (patch)
tree9dbe335d2f6e9b06a4aa81e4c7b990d36c12997b
parentb3b2c39df680f88e1e6d3615245754ae5f0380d0 (diff)
downloadelxr-f9544958194efb54e2c4f211a632964c488456e8.tar.gz
elxr-f9544958194efb54e2c4f211a632964c488456e8.zip
docs: readme update for object property example
-rw-r--r--README.md5
-rw-r--r--TODO.md12
2 files changed, 16 insertions, 1 deletions
diff --git a/README.md b/README.md
index 10460c7..f595163 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,8 @@ Example -
```js
filter(/ \T (\s | \n) /, [ null, 0, '2', 3, true ]) // > [ '2', 3 ]
+
+filter(/ \T[name \s\T] /, [ null, 0, { name: '' }, { name: 'phenax' } ]) // > [ { name: 'phenax' } ]
```
@@ -20,7 +22,8 @@ Whitespaces are ignore (exceptions: within string literals and nested regex)
* `a|b` => match `a` **or** `b`
* `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)
+* `(\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)
+* `[name \s\T]` => match property of object (example matches items with property `name` as non-empty string)
diff --git a/TODO.md b/TODO.md
new file mode 100644
index 0000000..37b7449
--- /dev/null
+++ b/TODO.md
@@ -0,0 +1,12 @@
+# TODO
+
+## Features
+ - [ ] Eval: Quantifiers
+ - [ ] Eval: Next item
+ - [ ] Parse: `{2, 5}` quantifiers
+ - [ ] Eval: `^$` start-end
+ - [ ] Parse, Eval: Not/Inverse
+ - [ ] Func: filter
+ - [ ] Func: match
+ - [ ] Func: replace
+