Merge pull request #44 from lambdalisue/add-is-unknown

👍 Add `isUnknown` predicate function
jsr-core · Nov 26, 2023 · 6cdf1e3 · 6cdf1e3
2 parents 8f8d181 + aec15fc
commit 6cdf1e3
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 0 deletions.
diff --git a/is.ts b/is.ts
@@ -18,6 +18,13 @@ export function isAny(_x: unknown): _x is any {
   return true;
 }
 
+/**
+ * Always return `true` regardless of the type of `x`.
+ */
+export function isUnknown(_x: unknown): _x is unknown {
+  return true;
+}
+
 /**
  * Return `true` if the type of `x` is `string`.
  */
@@ -508,6 +515,7 @@ export function isOptionalOf<T>(
 
 export default {
   Any: isAny,
+  Unknown: isUnknown,
   String: isString,
   Number: isNumber,
   BigInt: isBigInt,

diff --git a/is_test.ts b/is_test.ts
@@ -36,6 +36,7 @@ import is, {
   isTupleOf,
   isUndefined,
   isUniformTupleOf,
+  isUnknown,
   Predicate,
   PredicateType,
 } from "./is.ts";
@@ -135,6 +136,26 @@ Deno.test("isAny", async (t) => {
   });
 });
 
+Deno.test("isUnknown", async (t) => {
+  await testWithExamples(t, isUnknown, {
+    validExamples: [
+      "string",
+      "number",
+      "bigint",
+      "boolean",
+      "array",
+      "record",
+      "syncFunction",
+      "asyncFunction",
+      "null",
+      "undefined",
+      "symbol",
+      "date",
+      "promise",
+    ],
+  });
+});
+
 Deno.test("isString", async (t) => {
   await testWithExamples(t, isString, { validExamples: ["string"] });
 });