Release type-guarden

aaronccasanova · Nov 16, 2022 · 74ebe4b · 74ebe4b · vercel · Nov 16, 2022
1 parent ab97c05
commit 74ebe4b
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/.changeset/rare-crews-heal.md b/.changeset/rare-crews-heal.md
@@ -0,0 +1,5 @@
+---
+'type-guarden': patch
+---
+
+Refined existing APIs and added more basic type guards
diff --git a/packages/type-guarden/README.md b/packages/type-guarden/README.md
@@ -20,6 +20,9 @@ const obj = {
 
 const arr = ['foo', 'bar', 'baz']
 
+let key: unknown
+let element: unknown
+
 if (isKeyOf(obj, key)) {
   // `key` is 'foo' | 'baz'
 }
@@ -28,3 +31,22 @@ if (isElementOf(arr, element)) {
   // `element` is 'foo' | 'bar' | 'baz'
 }
 ```
+
+## APIs
+
+- `isKeyOf`
+- `isElementOf`
+- `isBigInt`
+- `isBoolean`
+- `isNull`
+- `isNumber`
+- `isString`
+- `isSymbol`
+- `isUndefined`
+- `isFunction`
+- `isObject`
+- `isPlainObject`
+- `isPromise`
+- `isPrimitive`
+- `isTruthy`
+- `isFalsy`