is-kit 1.1.1 → 1.1.3

package/README.md

@@ -116,6 +116,19 @@ Composed guards stay reusable:
 
 When validating complex shapes, reach for `struct` — and friends like `arrayOf`, `recordOf`, or `oneOf`.
 
+### Primitive guards
+
+Built-in primitives: `isString`, `isNumber` (finite), `isBoolean`, `isBigInt`, `isSymbol`, `isUndefined`, `isNull` — and a preset `isPrimitive` for any primitive.
+
+```ts
+import { isPrimitive, isNumber } from 'is-kit';
+
+isPrimitive('x'); // true
+isPrimitive(123); // true
+isPrimitive(NaN); // true (use isNumber for finite only)
+isPrimitive({}); // false
+```
+
 ## Core Ideas
 
 - **Define once**: `define<T>(fn)` turns a plain function into a type guard.

package/dist/index.d.mts

@@ -218,6 +218,15 @@ declare const isUndefined: Predicate<undefined>;
  * @returns Predicate narrowing to `null`.
  */
 declare const isNull: Predicate<null>;
+/**
+ * Checks whether a value is a JavaScript primitive.
+ *
+ * Primitives: string, number, boolean, bigint, symbol, undefined, null.
+ * Note: `number` here includes NaN and ±Infinity (use `isNumber` for finite only).
+ *
+ * @returns Predicate narrowing to `Primitive`.
+ */
+declare const isPrimitive: Guard<string | number | bigint | boolean | symbol | null | undefined>;
 
 /**
  * Validates an array where every element satisfies the provided guard.
@@ -324,6 +333,18 @@ declare const isMap: Predicate<Map<unknown, unknown>>;
  * @returns Predicate narrowing to `Set<unknown>`.
  */
 declare const isSet: Predicate<Set<unknown>>;
+/**
+ * Checks whether a value is a `WeakMap`.
+ *
+ * @returns Predicate narrowing to `WeakMap<object, unknown>`.
+ */
+declare const isWeakMap: Predicate<WeakMap<object, unknown>>;
+/**
+ * Checks whether a value is a `WeakSet`.
+ *
+ * @returns Predicate narrowing to `WeakSet<object>`.
+ */
+declare const isWeakSet: Predicate<WeakSet<object>>;
 /**
  * Checks whether a value is promise-like (has a `then` function).
  *
@@ -401,4 +422,4 @@ declare function narrowKeyTo<A, K extends keyof A>(guard: Guard<A>, key: K): <co
  */
 declare const toBooleanPredicates: (guards: readonly Guard<unknown>[]) => ReadonlyArray<(value: unknown) => boolean>;
 
-export { type ChainResult, type Guard, type GuardedOf, type GuardedWithin, type InferSchema, type OutOfGuards, type ParseResult, type Predicate, type Primitive, type Refine, type RefineChain, type Refinement, type Schema, and, andAll, arrayOf, define, equals, equalsBy, equalsKey, guardIn, isArray, isArrayBuffer, isAsyncIterable, isBigInt, isBlob, isBoolean, isDataView, isDate, isError, isFiniteNumber, isFunction, isIterable, isMap, isNull, isNumber, isNumberPrimitive, isObject, isPlainObject, isPromiseLike, isRegExp, isSet, isString, isSymbol, isTypedArray, isURL, isUndefined, narrowKeyTo, nonNull, not, nullable, nullish, oneOf, oneOfValues, optional, or, predicateToRefine, recordOf, required, safeParse, safeParseWith, struct, toBooleanPredicates, tupleOf };
+export { type ChainResult, type Guard, type GuardedOf, type GuardedWithin, type InferSchema, type OutOfGuards, type ParseResult, type Predicate, type Primitive, type Refine, type RefineChain, type Refinement, type Schema, and, andAll, arrayOf, define, equals, equalsBy, equalsKey, guardIn, isArray, isArrayBuffer, isAsyncIterable, isBigInt, isBlob, isBoolean, isDataView, isDate, isError, isFiniteNumber, isFunction, isIterable, isMap, isNull, isNumber, isNumberPrimitive, isObject, isPlainObject, isPrimitive, isPromiseLike, isRegExp, isSet, isString, isSymbol, isTypedArray, isURL, isUndefined, isWeakMap, isWeakSet, narrowKeyTo, nonNull, not, nullable, nullish, oneOf, oneOfValues, optional, or, predicateToRefine, recordOf, required, safeParse, safeParseWith, struct, toBooleanPredicates, tupleOf };

package/dist/index.d.ts

@@ -218,6 +218,15 @@ declare const isUndefined: Predicate<undefined>;
  * @returns Predicate narrowing to `null`.
  */
 declare const isNull: Predicate<null>;
+/**
+ * Checks whether a value is a JavaScript primitive.
+ *
+ * Primitives: string, number, boolean, bigint, symbol, undefined, null.
+ * Note: `number` here includes NaN and ±Infinity (use `isNumber` for finite only).
+ *
+ * @returns Predicate narrowing to `Primitive`.
+ */
+declare const isPrimitive: Guard<string | number | bigint | boolean | symbol | null | undefined>;
 
 /**
  * Validates an array where every element satisfies the provided guard.
@@ -324,6 +333,18 @@ declare const isMap: Predicate<Map<unknown, unknown>>;
  * @returns Predicate narrowing to `Set<unknown>`.
  */
 declare const isSet: Predicate<Set<unknown>>;
+/**
+ * Checks whether a value is a `WeakMap`.
+ *
+ * @returns Predicate narrowing to `WeakMap<object, unknown>`.
+ */
+declare const isWeakMap: Predicate<WeakMap<object, unknown>>;
+/**
+ * Checks whether a value is a `WeakSet`.
+ *
+ * @returns Predicate narrowing to `WeakSet<object>`.
+ */
+declare const isWeakSet: Predicate<WeakSet<object>>;
 /**
  * Checks whether a value is promise-like (has a `then` function).
  *
@@ -401,4 +422,4 @@ declare function narrowKeyTo<A, K extends keyof A>(guard: Guard<A>, key: K): <co
  */
 declare const toBooleanPredicates: (guards: readonly Guard<unknown>[]) => ReadonlyArray<(value: unknown) => boolean>;
 
-export { type ChainResult, type Guard, type GuardedOf, type GuardedWithin, type InferSchema, type OutOfGuards, type ParseResult, type Predicate, type Primitive, type Refine, type RefineChain, type Refinement, type Schema, and, andAll, arrayOf, define, equals, equalsBy, equalsKey, guardIn, isArray, isArrayBuffer, isAsyncIterable, isBigInt, isBlob, isBoolean, isDataView, isDate, isError, isFiniteNumber, isFunction, isIterable, isMap, isNull, isNumber, isNumberPrimitive, isObject, isPlainObject, isPromiseLike, isRegExp, isSet, isString, isSymbol, isTypedArray, isURL, isUndefined, narrowKeyTo, nonNull, not, nullable, nullish, oneOf, oneOfValues, optional, or, predicateToRefine, recordOf, required, safeParse, safeParseWith, struct, toBooleanPredicates, tupleOf };
+export { type ChainResult, type Guard, type GuardedOf, type GuardedWithin, type InferSchema, type OutOfGuards, type ParseResult, type Predicate, type Primitive, type Refine, type RefineChain, type Refinement, type Schema, and, andAll, arrayOf, define, equals, equalsBy, equalsKey, guardIn, isArray, isArrayBuffer, isAsyncIterable, isBigInt, isBlob, isBoolean, isDataView, isDate, isError, isFiniteNumber, isFunction, isIterable, isMap, isNull, isNumber, isNumberPrimitive, isObject, isPlainObject, isPrimitive, isPromiseLike, isRegExp, isSet, isString, isSymbol, isTypedArray, isURL, isUndefined, isWeakMap, isWeakSet, narrowKeyTo, nonNull, not, nullable, nullish, oneOf, oneOfValues, optional, or, predicateToRefine, recordOf, required, safeParse, safeParseWith, struct, toBooleanPredicates, tupleOf };

package/dist/index.js

@@ -46,6 +46,7 @@ __export(index_exports, {
   isNumberPrimitive: () => isNumberPrimitive,
   isObject: () => isObject,
   isPlainObject: () => isPlainObject,
+  isPrimitive: () => isPrimitive,
   isPromiseLike: () => isPromiseLike,
   isRegExp: () => isRegExp,
   isSet: () => isSet,
@@ -54,6 +55,8 @@ __export(index_exports, {
   isTypedArray: () => isTypedArray,
   isURL: () => isURL,
   isUndefined: () => isUndefined,
+  isWeakMap: () => isWeakMap,
+  isWeakSet: () => isWeakSet,
   narrowKeyTo: () => narrowKeyTo,
   nonNull: () => nonNull,
   not: () => not,
@@ -160,6 +163,12 @@ var isMap = define(
 var isSet = define(
   (value) => getTag(value) === "[object Set]"
 );
+var isWeakMap = define(
+  (value) => getTag(value) === "[object WeakMap]"
+);
+var isWeakSet = define(
+  (value) => getTag(value) === "[object WeakSet]"
+);
 var isPromiseLike = define((value) => {
   if (!isObject(value) && !isFunction(value)) return false;
   return typeof value.then === "function";
@@ -230,6 +239,15 @@ var isBigInt = define((value) => typeof value === "bigint");
 var isSymbol = define((value) => typeof value === "symbol");
 var isUndefined = define((value) => value === void 0);
 var isNull = define((value) => value === null);
+var isPrimitive = or(
+  isString,
+  isNumberPrimitive,
+  isBoolean,
+  isBigInt,
+  isSymbol,
+  isUndefined,
+  isNull
+);
 
 // src/core/combinators/array.ts
 function arrayOf(elementGuard) {
@@ -272,16 +290,17 @@ function recordOf(keyFunction, valueFunction) {
 
 // src/core/combinators/struct.ts
 function struct(schema, options) {
+  const schemaKeys = Object.keys(schema);
+  const allowed = options?.exact ? new Set(schemaKeys) : null;
   return (input) => {
     if (!isPlainObject(input)) return false;
     const obj = input;
-    for (const key of Object.keys(schema)) {
+    for (const key of schemaKeys) {
       if (!(key in obj)) return false;
       const guard = schema[key];
       if (!guard(obj[key])) return false;
     }
-    if (options?.exact) {
-      const allowed = new Set(Object.keys(schema));
+    if (allowed) {
       for (const key of Object.keys(obj)) {
         if (!allowed.has(key)) return false;
       }
@@ -309,9 +328,9 @@ function oneOfValues(...values) {
 function narrowKeyTo(guard, key) {
   return function(target) {
     const keyEquals = equalsKey(key, target);
-    return function(input) {
+    return define(function(input) {
       return guard(input) && keyEquals(input);
-    };
+    });
   };
 }
 // Annotate the CommonJS export names for ESM import in node:
@@ -342,6 +361,7 @@ function narrowKeyTo(guard, key) {
   isNumberPrimitive,
   isObject,
   isPlainObject,
+  isPrimitive,
   isPromiseLike,
   isRegExp,
   isSet,
@@ -350,6 +370,8 @@ function narrowKeyTo(guard, key) {
   isTypedArray,
   isURL,
   isUndefined,
+  isWeakMap,
+  isWeakSet,
   narrowKeyTo,
   nonNull,
   not,

package/dist/index.mjs

@@ -84,6 +84,12 @@ var isMap = define(
 var isSet = define(
   (value) => getTag(value) === "[object Set]"
 );
+var isWeakMap = define(
+  (value) => getTag(value) === "[object WeakMap]"
+);
+var isWeakSet = define(
+  (value) => getTag(value) === "[object WeakSet]"
+);
 var isPromiseLike = define((value) => {
   if (!isObject(value) && !isFunction(value)) return false;
   return typeof value.then === "function";
@@ -154,6 +160,15 @@ var isBigInt = define((value) => typeof value === "bigint");
 var isSymbol = define((value) => typeof value === "symbol");
 var isUndefined = define((value) => value === void 0);
 var isNull = define((value) => value === null);
+var isPrimitive = or(
+  isString,
+  isNumberPrimitive,
+  isBoolean,
+  isBigInt,
+  isSymbol,
+  isUndefined,
+  isNull
+);
 
 // src/core/combinators/array.ts
 function arrayOf(elementGuard) {
@@ -196,16 +211,17 @@ function recordOf(keyFunction, valueFunction) {
 
 // src/core/combinators/struct.ts
 function struct(schema, options) {
+  const schemaKeys = Object.keys(schema);
+  const allowed = options?.exact ? new Set(schemaKeys) : null;
   return (input) => {
     if (!isPlainObject(input)) return false;
     const obj = input;
-    for (const key of Object.keys(schema)) {
+    for (const key of schemaKeys) {
       if (!(key in obj)) return false;
       const guard = schema[key];
       if (!guard(obj[key])) return false;
     }
-    if (options?.exact) {
-      const allowed = new Set(Object.keys(schema));
+    if (allowed) {
       for (const key of Object.keys(obj)) {
         if (!allowed.has(key)) return false;
       }
@@ -233,9 +249,9 @@ function oneOfValues(...values) {
 function narrowKeyTo(guard, key) {
   return function(target) {
     const keyEquals = equalsKey(key, target);
-    return function(input) {
+    return define(function(input) {
       return guard(input) && keyEquals(input);
-    };
+    });
   };
 }
 export {
@@ -265,6 +281,7 @@ export {
   isNumberPrimitive,
   isObject,
   isPlainObject,
+  isPrimitive,
   isPromiseLike,
   isRegExp,
   isSet,
@@ -273,6 +290,8 @@ export {
   isTypedArray,
   isURL,
   isUndefined,
+  isWeakMap,
+  isWeakSet,
   narrowKeyTo,
   nonNull,
   not,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "is-kit",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "description": "Make 'isXXX' easier. Let's make your code type safe and more readable!",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",