is-kit 1.1.2 → 1.1.4

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

@@ -136,8 +136,8 @@ declare function equals<const T>(target: T): Predicate<T>;
  * @param selector Optional selector to project the comparable key; if omitted, returns a function to supply it later.
  * @returns Function that accepts a target and returns a predicate over the original value.
  */
-declare function equalsBy<F extends (value: unknown) => value is unknown>(guard: F): <K>(selector: (value: GuardedOf<F>) => K) => <const T extends K>(target: T) => Predicate<GuardedOf<F>>;
-declare function equalsBy<F extends (value: unknown) => value is unknown, K>(guard: F, selector: (value: GuardedOf<F>) => K): <const T extends K>(target: T) => Predicate<GuardedOf<F>>;
+declare function equalsBy<F extends Predicate<unknown>>(guard: F): <K>(selector: (value: GuardedOf<F>) => K) => <const T extends K>(target: T) => Predicate<GuardedOf<F>>;
+declare function equalsBy<F extends Predicate<unknown>, K>(guard: F, selector: (value: GuardedOf<F>) => K): <const T extends K>(target: T) => Predicate<GuardedOf<F>>;
 /**
  * Creates a guard that matches objects having a key equal to the target value.
  *
@@ -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.
@@ -413,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, isWeakMap, isWeakSet, 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

@@ -136,8 +136,8 @@ declare function equals<const T>(target: T): Predicate<T>;
  * @param selector Optional selector to project the comparable key; if omitted, returns a function to supply it later.
  * @returns Function that accepts a target and returns a predicate over the original value.
  */
-declare function equalsBy<F extends (value: unknown) => value is unknown>(guard: F): <K>(selector: (value: GuardedOf<F>) => K) => <const T extends K>(target: T) => Predicate<GuardedOf<F>>;
-declare function equalsBy<F extends (value: unknown) => value is unknown, K>(guard: F, selector: (value: GuardedOf<F>) => K): <const T extends K>(target: T) => Predicate<GuardedOf<F>>;
+declare function equalsBy<F extends Predicate<unknown>>(guard: F): <K>(selector: (value: GuardedOf<F>) => K) => <const T extends K>(target: T) => Predicate<GuardedOf<F>>;
+declare function equalsBy<F extends Predicate<unknown>, K>(guard: F, selector: (value: GuardedOf<F>) => K): <const T extends K>(target: T) => Predicate<GuardedOf<F>>;
 /**
  * Creates a guard that matches objects having a key equal to the target value.
  *
@@ -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.
@@ -413,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, isWeakMap, isWeakSet, 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,
@@ -84,7 +85,7 @@ function define(fn) {
 // src/core/predicate.ts
 var predicateToRefine = (fn) => (value) => fn(value);
 
-// src/utils/util.ts
+// src/utils/to-boolean-predicates.ts
 var toBooleanPredicates = (guards) => guards;
 
 // src/core/logic.ts
@@ -238,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) {
@@ -259,7 +269,7 @@ function tupleOf(...guards) {
   };
 }
 
-// src/core/combinators/one.ts
+// src/core/combinators/one-of.ts
 function oneOf(...guards) {
   return (input) => guards.some((guard) => guard(input));
 }
@@ -280,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;
       }
@@ -350,6 +361,7 @@ function narrowKeyTo(guard, key) {
   isNumberPrimitive,
   isObject,
   isPlainObject,
+  isPrimitive,
   isPromiseLike,
   isRegExp,
   isSet,

package/dist/index.mjs

@@ -6,7 +6,7 @@ function define(fn) {
 // src/core/predicate.ts
 var predicateToRefine = (fn) => (value) => fn(value);
 
-// src/utils/util.ts
+// src/utils/to-boolean-predicates.ts
 var toBooleanPredicates = (guards) => guards;
 
 // src/core/logic.ts
@@ -160,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) {
@@ -181,7 +190,7 @@ function tupleOf(...guards) {
   };
 }
 
-// src/core/combinators/one.ts
+// src/core/combinators/one-of.ts
 function oneOf(...guards) {
   return (input) => guards.some((guard) => guard(input));
 }
@@ -202,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;
       }
@@ -271,6 +281,7 @@ export {
   isNumberPrimitive,
   isObject,
   isPlainObject,
+  isPrimitive,
   isPromiseLike,
   isRegExp,
   isSet,

package/package.json

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