extend is and isNot helper with support for RegExp as second argument

Author: ECorreia45

docs/documentation/utilities/is-&-isnot.md

@@ -18,6 +18,17 @@ html`${when(is(status, 'pending'), html`<p>loading...</p>`, html`<p>done</p>`)}`
 
 Both the `is` and `isNot` take two arguments, a state or some data, and a value or a checker. They will always return a boolean as the result.
 
+### RegExp
+
+You can also use `is` and `isNot` with regular expressions to check if a string matches a pattern.
+
+```javascript
+const [email, setEmail] = state('');
+
+const isEmailValid = is(email, /^[^\s@]+@[^\s@]+\.[^\s@]+$/);
+const isEmailInvalid = isNot(email, /^[^\s@]+@[^\s@]+\.[^\s@]+$/);
+```
+
 ### Checker
 
 The more advance way to use the `is` and `isNot` utilities is by providing a function as second argument that is called with the value and must return a boolean.
@@ -32,4 +43,4 @@ const isGreaterThanTen = is(count, (n) => n > 10)
 const isNotPending = isNot(status, (st) => st !== 'pending')
 ```
 
-When they consume state as first argument, their result get re-evaluated with every change which allows it to be handy in quick validators.
+When they consume `StateGetter` as first argument, their result get re-evaluated with every change which allows it to be handy in quick validators.

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@beforesemicolon/markup",
-    "version": "1.14.1",
+    "version": "1.15.0",
     "description": "Reactive HTML Templating System",
     "engines": {
         "node": ">=18.16.0"

src/helpers/is-not.helper.spec.ts

@@ -4,6 +4,10 @@ describe('isNot', () => { // @ts-ignore
 
 	it('should handle isNot', () => {
 		expect(isNot(() => true, true)()).toBe(false)
+		expect(isNot(() => true, false)()).toBe(true)
 		expect(isNot(() => true, () => false)()).toBe(true)
+		expect(isNot(12, /[0-9]+/)()).toBe(false)
+		expect(isNot(12, /^[0-9]$/)()).toBe(true)
+		expect(isNot('idle', /^(idle|loading)$/)()).toBe(false)
 	})
 })

src/helpers/is-not.helper.ts

@@ -8,12 +8,12 @@ import { is } from './is.helper.ts'
 /**
  * checks whether the state value is NOT equal to provided value or return value of the function checker
  * @param st
- * @param checker
+ * @param dataOrCheckerFn
  */
 export const isNot =
     <T>(
         st: T | StateGetter<T>,
-        checker: HelperValueChecker<T> | AnythingButAFunction<T>
+        dataOrCheckerFn: HelperValueChecker<T> | AnythingButAFunction<T>
     ) =>
     () =>
-        !is(st, checker)()
+        !is(st, dataOrCheckerFn)()

src/helpers/is.helper.spec.ts

@@ -4,6 +4,10 @@ describe('is', () => { // @ts-ignore
 
 	it('should handle is', () => {
 		expect(is(() => true, true)()).toBe(true)
-		expect(is(() => true, () =>false)()).toBe(false)
+		expect(is(() => true, false)()).toBe(false)
+		expect(is(() => true, () => false)()).toBe(false)
+		expect(is(12, /[0-9]+/)()).toBe(true)
+		expect(is(12, /^[0-9]$/)()).toBe(false)
+		expect(is('idle', /^(idle|loading)$/)()).toBe(true)
 	})
 })

src/helpers/is.helper.ts

@@ -8,14 +8,23 @@ import { val } from './val.ts'
 /**
  * checks whether the state value is equal to provided value or return value of the function checker
  * @param st
- * @param checker
+ * @param dataOrCheckerFn
  */
 export const is =
     <T>(
         st: T | StateGetter<T>,
-        checker: HelperValueChecker<T> | AnythingButAFunction<T>
+        dataOrCheckerFn: HelperValueChecker<T> | AnythingButAFunction<T>
     ) =>
-    () =>
-        typeof checker === 'function'
-            ? Boolean((checker as HelperValueChecker<T>)(val(st)))
-            : val(st) === checker
+    () => {
+        const value = val<T>(st)
+
+        if (typeof dataOrCheckerFn === 'function') {
+            return Boolean((dataOrCheckerFn as HelperValueChecker<T>)(value))
+        }
+
+        if (dataOrCheckerFn instanceof RegExp) {
+            return dataOrCheckerFn.test(String(value))
+        }
+
+        return value === dataOrCheckerFn
+    }