From d43d9e5933b1bc92e362321b054c951a4a4b000f Mon Sep 17 00:00:00 2001
From: Akshay Nair <phenax5@gmail.com>
Date: Thu, 17 Feb 2022 21:43:14 +0530
Subject: docs: adds replaceAll example

---
 README.md             | 14 ++++++++++++++
 tests/replace.spec.ts |  9 +++++++++
 2 files changed, 23 insertions(+)

diff --git a/README.md b/README.md
index f6e4054..eb2c9ee 100644
--- a/README.md
+++ b/README.md
@@ -36,6 +36,9 @@ Whitespaces are ignored (except within literals)
 
 ### Examples
 
+
+#### matchAll
+
 ```js
 // | Match for any number or any non-empty string or any object with `prop` is true
 matchAll(/ \n | \s\T /, [null, 23, '', 'wow', false ]
@@ -81,3 +84,14 @@ matchAll(/ [seperator true], [id \s\T]+ /, [
 // }
 ```
 
+
+#### replaceAll
+
+```js
+// | Match for any number or any non-empty string or any object with `prop` is true
+const replacer = (_, matches) => matches.value.reduce((a, b) => a + b, 0)
+replaceAll(/ \n+ /, replacer, [ 'start', 3, 5, 'mid', 2, 0, 4, 'end' ])
+
+// > [ 'start', 8, 'mid', 6, 'end' ]
+```
+
diff --git a/tests/replace.spec.ts b/tests/replace.spec.ts
index dd82eaa..98f1540 100644
--- a/tests/replace.spec.ts
+++ b/tests/replace.spec.ts
@@ -3,6 +3,15 @@ import { replaceAll } from '../src'
 
 describe('Basic tests', () => {
   it('should', () => {
+    const replacer = (_, matches) => [matches.value.reduce((a, b) => a + b, 0)]
+    expect(replaceAll(/ \n+ /, replacer, ['start', 3, 5, 'mid', 2, 0, 4, 'end'])).toEqual([
+      'start',
+      8,
+      'mid',
+      6,
+      'end',
+    ])
+
     expect(
       replaceAll(/"start", \s, \n/, _ => ['replaced'], [
         1,
-- 
cgit v1.3.1