is-kit 1.2.0 → 1.4.0

package/README.md

@@ -157,20 +157,48 @@ isInfiniteNumber(Infinity); // true
 isInfiniteNumber(1); // false
 ```
 
+### Object guards
+
+Object/built-in guards cover arrays, dates, maps/sets, and more. Use
+`isInstanceOf` when you want a reusable guard from a class constructor.
+
+```ts
+import { isArray, isDate, isInstanceOf } from 'is-kit';
+
+class Animal {}
+class Dog extends Animal {}
+
+const isAnimal = isInstanceOf(Animal);
+
+isArray([]); // true
+isDate(new Date()); // true
+isAnimal(new Dog()); // true
+isAnimal({}); // false
+```
+
 ## Core Ideas
 
 - **Define once**: `define<T>(fn)` turns a plain function into a type guard.
 - **Upgrade predicates**: `predicateToRefine(fn)` adds narrowing.
 - **Compose freely**: `and`, `or`, `not`, `oneOf`, `arrayOf`, `struct` …
-- **Stay ergonomic**: helpers like `nullable`, `optional`, `equals`, `safeParse`, `assert`, `hasKey`, `narrowKeyTo`.
+- **Stay ergonomic**: helpers like `nullable`, `optional`, `equals`, `safeParse`, `assert`, `hasKey`, `hasKeys`, `narrowKeyTo`.
 
 ### Key Helpers
 
-Use `hasKey` to check for a required own property before refining, and
+Use `hasKey`/`hasKeys` to check required own properties before refining, and
 `narrowKeyTo` when you need to narrow a property to a specific literal value.
 
 ```ts
-import { hasKey, isString, isNumber, narrowKeyTo, or, struct } from 'is-kit';
+import {
+  hasKey,
+  hasKeys,
+  isString,
+  isNumber,
+  narrowKeyTo,
+  oneOfValues,
+  or,
+  struct
+} from 'is-kit';
 
 // Base guard (e.g., via struct)
 type User = { id: string; age: number; role: 'admin' | 'guest' | 'trial' };
@@ -181,6 +209,7 @@ const isUser = struct({
 });
 
 const hasRole = hasKey('role');
+const hasRoleAndId = hasKeys('role', 'id');
 const byRole = narrowKeyTo(isUser, 'role');
 const isGuest = byRole('guest'); // Readonly<User> & { role: 'guest' }
 const isTrial = byRole('trial'); // Readonly<User> & { role: 'trial' }
@@ -191,6 +220,11 @@ if (hasRole(value)) {
   value.role;
 }
 
+if (hasRoleAndId(value)) {
+  value.role;
+  value.id;
+}
+
 if (isGuestOrTrial(value)) {
   // value.role is 'guest' | 'trial'
 }

package/dist/index.d.mts

@@ -461,6 +461,13 @@ declare const isURL: Predicate<URL>;
  * @returns Predicate narrowing to `Blob` when supported; otherwise always false.
  */
 declare const isBlob: Predicate<Blob>;
+/**
+ * Creates a guard that checks whether a value is an instance of `constructor`.
+ *
+ * @param constructor Constructor used as the right-hand side of `instanceof`.
+ * @returns Predicate narrowing to `InstanceType<C>`.
+ */
+declare const isInstanceOf: <C extends abstract new (...args: unknown[]) => unknown>(constructor: C) => Guard<InstanceType<C>>;
 
 /**
  * Checks whether a value has the specified own key.
@@ -469,6 +476,13 @@ declare const isBlob: Predicate<Blob>;
  * @returns Predicate narrowing to an object with the key present.
  */
 declare const hasKey: <K extends PropertyKey>(key: K) => Predicate<Record<K, unknown>>;
+/**
+ * Checks whether a value has all specified own keys.
+ *
+ * @param keys Property keys to check.
+ * @returns Predicate narrowing to an object with all keys present.
+ */
+declare const hasKeys: <const KS extends readonly [PropertyKey, ...PropertyKey[]]>(...keys: KS) => Predicate<Record<KS[number], unknown>>;
 /**
  * Builds a guard that narrows a specific key to the provided literal value.
  *
@@ -491,4 +505,4 @@ declare function narrowKeyTo<A, K extends keyof A>(guard: Guard<A>, key: K): <co
  */
 declare const toBooleanPredicates: <A>(predicates: readonly ((value: A) => boolean)[]) => ReadonlyArray<(value: A) => 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, assert, define, equals, equalsBy, equalsKey, guardIn, hasKey, isArray, isArrayBuffer, isAsyncIterable, isBigInt, isBlob, isBoolean, isDataView, isDate, isError, isFiniteNumber, isFunction, isInfiniteNumber, isInteger, isIterable, isMap, isNaN, isNegative, isNull, isNumber, isNumberPrimitive, isObject, isPlainObject, isPositive, isPrimitive, isPromiseLike, isRegExp, isSafeInteger, isSet, isString, isSymbol, isTypedArray, isURL, isUndefined, isWeakMap, isWeakSet, isZero, 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, assert, define, equals, equalsBy, equalsKey, guardIn, hasKey, hasKeys, isArray, isArrayBuffer, isAsyncIterable, isBigInt, isBlob, isBoolean, isDataView, isDate, isError, isFiniteNumber, isFunction, isInfiniteNumber, isInstanceOf, isInteger, isIterable, isMap, isNaN, isNegative, isNull, isNumber, isNumberPrimitive, isObject, isPlainObject, isPositive, isPrimitive, isPromiseLike, isRegExp, isSafeInteger, isSet, isString, isSymbol, isTypedArray, isURL, isUndefined, isWeakMap, isWeakSet, isZero, narrowKeyTo, nonNull, not, nullable, nullish, oneOf, oneOfValues, optional, or, predicateToRefine, recordOf, required, safeParse, safeParseWith, struct, toBooleanPredicates, tupleOf };

package/dist/index.d.ts

@@ -461,6 +461,13 @@ declare const isURL: Predicate<URL>;
  * @returns Predicate narrowing to `Blob` when supported; otherwise always false.
  */
 declare const isBlob: Predicate<Blob>;
+/**
+ * Creates a guard that checks whether a value is an instance of `constructor`.
+ *
+ * @param constructor Constructor used as the right-hand side of `instanceof`.
+ * @returns Predicate narrowing to `InstanceType<C>`.
+ */
+declare const isInstanceOf: <C extends abstract new (...args: unknown[]) => unknown>(constructor: C) => Guard<InstanceType<C>>;
 
 /**
  * Checks whether a value has the specified own key.
@@ -469,6 +476,13 @@ declare const isBlob: Predicate<Blob>;
  * @returns Predicate narrowing to an object with the key present.
  */
 declare const hasKey: <K extends PropertyKey>(key: K) => Predicate<Record<K, unknown>>;
+/**
+ * Checks whether a value has all specified own keys.
+ *
+ * @param keys Property keys to check.
+ * @returns Predicate narrowing to an object with all keys present.
+ */
+declare const hasKeys: <const KS extends readonly [PropertyKey, ...PropertyKey[]]>(...keys: KS) => Predicate<Record<KS[number], unknown>>;
 /**
  * Builds a guard that narrows a specific key to the provided literal value.
  *
@@ -491,4 +505,4 @@ declare function narrowKeyTo<A, K extends keyof A>(guard: Guard<A>, key: K): <co
  */
 declare const toBooleanPredicates: <A>(predicates: readonly ((value: A) => boolean)[]) => ReadonlyArray<(value: A) => 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, assert, define, equals, equalsBy, equalsKey, guardIn, hasKey, isArray, isArrayBuffer, isAsyncIterable, isBigInt, isBlob, isBoolean, isDataView, isDate, isError, isFiniteNumber, isFunction, isInfiniteNumber, isInteger, isIterable, isMap, isNaN, isNegative, isNull, isNumber, isNumberPrimitive, isObject, isPlainObject, isPositive, isPrimitive, isPromiseLike, isRegExp, isSafeInteger, isSet, isString, isSymbol, isTypedArray, isURL, isUndefined, isWeakMap, isWeakSet, isZero, 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, assert, define, equals, equalsBy, equalsKey, guardIn, hasKey, hasKeys, isArray, isArrayBuffer, isAsyncIterable, isBigInt, isBlob, isBoolean, isDataView, isDate, isError, isFiniteNumber, isFunction, isInfiniteNumber, isInstanceOf, isInteger, isIterable, isMap, isNaN, isNegative, isNull, isNumber, isNumberPrimitive, isObject, isPlainObject, isPositive, isPrimitive, isPromiseLike, isRegExp, isSafeInteger, isSet, isString, isSymbol, isTypedArray, isURL, isUndefined, isWeakMap, isWeakSet, isZero, narrowKeyTo, nonNull, not, nullable, nullish, oneOf, oneOfValues, optional, or, predicateToRefine, recordOf, required, safeParse, safeParseWith, struct, toBooleanPredicates, tupleOf };

package/dist/index.js

@@ -30,6 +30,7 @@ __export(index_exports, {
   equalsKey: () => equalsKey,
   guardIn: () => guardIn,
   hasKey: () => hasKey,
+  hasKeys: () => hasKeys,
   isArray: () => isArray,
   isArrayBuffer: () => isArrayBuffer,
   isAsyncIterable: () => isAsyncIterable,
@@ -42,6 +43,7 @@ __export(index_exports, {
   isFiniteNumber: () => isFiniteNumber,
   isFunction: () => isFunction,
   isInfiniteNumber: () => isInfiniteNumber,
+  isInstanceOf: () => isInstanceOf,
   isInteger: () => isInteger,
   isIterable: () => isIterable,
   isMap: () => isMap,
@@ -218,6 +220,7 @@ var isError = define(
 );
 var isURL = typeof URL !== "undefined" ? define((value) => value instanceof URL) : define(() => false);
 var isBlob = typeof Blob !== "undefined" ? define((value) => value instanceof Blob) : define(() => false);
+var isInstanceOf = (constructor) => define((value) => value instanceof constructor);
 
 // src/core/equals.ts
 function equals(target) {
@@ -389,6 +392,14 @@ function oneOfValues(...args) {
 var hasKey = (key) => define(
   (input) => isObject(input) && Object.prototype.hasOwnProperty.call(input, key)
 );
+var hasKeys = (...keys) => {
+  if (keys.length === 0) {
+    return define(() => false);
+  }
+  return define(
+    (input) => isObject(input) && keys.every((key) => Object.prototype.hasOwnProperty.call(input, key))
+  );
+};
 function narrowKeyTo(guard, key) {
   return function(target) {
     const keyEquals = equalsKey(key, target);
@@ -409,6 +420,7 @@ function narrowKeyTo(guard, key) {
   equalsKey,
   guardIn,
   hasKey,
+  hasKeys,
   isArray,
   isArrayBuffer,
   isAsyncIterable,
@@ -421,6 +433,7 @@ function narrowKeyTo(guard, key) {
   isFiniteNumber,
   isFunction,
   isInfiniteNumber,
+  isInstanceOf,
   isInteger,
   isIterable,
   isMap,

package/dist/index.mjs

@@ -130,6 +130,7 @@ var isError = define(
 );
 var isURL = typeof URL !== "undefined" ? define((value) => value instanceof URL) : define(() => false);
 var isBlob = typeof Blob !== "undefined" ? define((value) => value instanceof Blob) : define(() => false);
+var isInstanceOf = (constructor) => define((value) => value instanceof constructor);
 
 // src/core/equals.ts
 function equals(target) {
@@ -301,6 +302,14 @@ function oneOfValues(...args) {
 var hasKey = (key) => define(
   (input) => isObject(input) && Object.prototype.hasOwnProperty.call(input, key)
 );
+var hasKeys = (...keys) => {
+  if (keys.length === 0) {
+    return define(() => false);
+  }
+  return define(
+    (input) => isObject(input) && keys.every((key) => Object.prototype.hasOwnProperty.call(input, key))
+  );
+};
 function narrowKeyTo(guard, key) {
   return function(target) {
     const keyEquals = equalsKey(key, target);
@@ -320,6 +329,7 @@ export {
   equalsKey,
   guardIn,
   hasKey,
+  hasKeys,
   isArray,
   isArrayBuffer,
   isAsyncIterable,
@@ -332,6 +342,7 @@ export {
   isFiniteNumber,
   isFunction,
   isInfiniteNumber,
+  isInstanceOf,
   isInteger,
   isIterable,
   isMap,

package/package.json

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