@infra-blocks/types 0.17.0-alpha.1 → 0.18.0-alpha.0

package/lib/cjs/func.d.ts

@@ -1,3 +1,11 @@
+/**
+ * The async flavor of {@link Factory}.
+ */
+export type AsyncFactory<P extends unknown[], R> = (...params: P) => Promise<R>;
+/**
+ * A type alias for asynchronous provider functions.
+ */
+export type AsyncProvider<T> = () => Promise<T>;
 /**
  * Convenient type to easily represent "callable" types and to avoid using
  * "any" in client code.
@@ -8,26 +16,22 @@ export type Callable = (...args: never[]) => unknown;
  */
 export type Constructor<R = object, A extends any[] = any[]> = new (...args: A) => R;
 /**
- * A type alias for single element predicate functions.
- */
-export type Predicate<T> = (item: T) => boolean;
-/**
- * A type alias for functions that return a value of a given type without arguments.
- */
-export type Provider<T> = () => T;
-/**
- * A type alias for asynchronous provider functions.
+ * A convenient type declaration for handlers used to resolve "error" type events.
  */
-export type AsyncProvider<T> = () => Promise<T>;
+export type ErrorHandler<T extends Error = Error> = (err: T) => void;
 /**
  * A type alias for a function that creates objects of a given type.
  */
 export type Factory<P extends unknown[], R> = (...params: P) => R;
 /**
- * The async flavor of {@link Factory}.
+ * A type alias for single element predicate functions.
  */
-export type AsyncFactory<P extends unknown[], R> = (...params: P) => Promise<R>;
+export type Predicate<T> = (item: T) => boolean;
 /**
- * A convenient type declaration for handlers used to resolve "error" type events.
+ * A type alias for functions that return a value of a given type without arguments.
  */
-export type ErrorHandler<T extends Error = Error> = (err: T) => void;
+export type Provider<T> = () => T;
+/**
+ * A type alias for type guards.
+ */
+export type TypeGuard<T extends V, V = unknown> = (value: V) => value is T;

package/lib/esm/func.d.ts

@@ -1,3 +1,11 @@
+/**
+ * The async flavor of {@link Factory}.
+ */
+export type AsyncFactory<P extends unknown[], R> = (...params: P) => Promise<R>;
+/**
+ * A type alias for asynchronous provider functions.
+ */
+export type AsyncProvider<T> = () => Promise<T>;
 /**
  * Convenient type to easily represent "callable" types and to avoid using
  * "any" in client code.
@@ -8,26 +16,22 @@ export type Callable = (...args: never[]) => unknown;
  */
 export type Constructor<R = object, A extends any[] = any[]> = new (...args: A) => R;
 /**
- * A type alias for single element predicate functions.
- */
-export type Predicate<T> = (item: T) => boolean;
-/**
- * A type alias for functions that return a value of a given type without arguments.
- */
-export type Provider<T> = () => T;
-/**
- * A type alias for asynchronous provider functions.
+ * A convenient type declaration for handlers used to resolve "error" type events.
  */
-export type AsyncProvider<T> = () => Promise<T>;
+export type ErrorHandler<T extends Error = Error> = (err: T) => void;
 /**
  * A type alias for a function that creates objects of a given type.
  */
 export type Factory<P extends unknown[], R> = (...params: P) => R;
 /**
- * The async flavor of {@link Factory}.
+ * A type alias for single element predicate functions.
  */
-export type AsyncFactory<P extends unknown[], R> = (...params: P) => Promise<R>;
+export type Predicate<T> = (item: T) => boolean;
 /**
- * A convenient type declaration for handlers used to resolve "error" type events.
+ * A type alias for functions that return a value of a given type without arguments.
  */
-export type ErrorHandler<T extends Error = Error> = (err: T) => void;
+export type Provider<T> = () => T;
+/**
+ * A type alias for type guards.
+ */
+export type TypeGuard<T extends V, V = unknown> = (value: V) => value is T;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@infra-blocks/types",
-  "version": "0.17.0-alpha.1",
+  "version": "0.18.0-alpha.0",
   "description": "Typescript types utility package.",
   "keywords": [
     "type",
@@ -43,6 +43,7 @@
     "@typescript-eslint/eslint-plugin": "^5.59.8",
     "@typescript-eslint/parser": "^5.59.8",
     "c8": "^8.0.0",
+    "conditional-type-checks": "^1.0.6",
     "eslint": "^8.41.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-json-format": "^2.0.1",