@infra-blocks/types 0.6.0-alpha.1 → 0.6.0-alpha.3

package/README.md

@@ -1,7 +1,7 @@
 # ts-types
-[![Build](https://github.com/infrastructure-blocks/ts-types/actions/workflows/build.yml/badge.svg)](https://github.com/infrastructure-blocks/ts-types/actions/workflows/build.yml)
-[![Release](https://github.com/infrastructure-blocks/ts-types/actions/workflows/release.yml/badge.svg)](https://github.com/infrastructure-blocks/ts-types/actions/workflows/release.yml)
-[![Update From Template](https://github.com/infrastructure-blocks/ts-types/actions/workflows/update-from-template.yml/badge.svg)](https://github.com/infrastructure-blocks/ts-types/actions/workflows/update-from-template.yml)
-[![codecov](https://codecov.io/gh/infrastructure-blocks/ts-types/graph/badge.svg?token=EHQLSLTN3K)](https://codecov.io/gh/infrastructure-blocks/ts-types)
+[![Build](https://github.com/infra-blocks/ts-types/actions/workflows/build.yml/badge.svg)](https://github.com/infra-blocks/ts-types/actions/workflows/build.yml)
+[![Release](https://github.com/infra-blocks/ts-types/actions/workflows/release.yml/badge.svg)](https://github.com/infra-blocks/ts-types/actions/workflows/release.yml)
+[![Update From Template](https://github.com/infra-blocks/ts-types/actions/workflows/update-from-template.yml/badge.svg)](https://github.com/infra-blocks/ts-types/actions/workflows/update-from-template.yml)
+[![codecov](https://codecov.io/gh/infra-blocks/ts-types/graph/badge.svg?token=YP8OHUAHHX)](https://codecov.io/gh/infra-blocks/ts-types)
 
 Types utility library for Typescript.

package/lib/cjs/events.d.ts

@@ -0,0 +1,48 @@
+/// <reference types="node" resolution-mode="require"/>
+import EventEmitter from "node:events";
+/**
+ * Describes the interface that "Event" types must implement.
+ *
+ * Every key must resolve to a callable that describes the type of the
+ * handler for the event.
+ */
+export type Events = {
+    [key: string]: (...args: any[]) => void;
+};
+/**
+ * An interface for classes that behave like event emitters.
+ *
+ * Those typically allow subscription to a very specific set of events but do not export
+ * the emitting capabilities.
+ */
+export interface EmitterLike<E extends Events> {
+    /**
+     * Subscribes a handler to the specific event type.
+     * @param event
+     * @param handler
+     */
+    on<Event extends keyof E>(event: Event, handler: E[Event]): this;
+}
+/**
+ * A generic implementation of {@link EmitterLike}.
+ *
+ * Classes that want to implement the {@link EmitterLike} interface using a NodeJs
+ * event emitter can do so by extending this class.
+ *
+ * It simply delegates `on` calls to the underlying event emitter. It also provides
+ * an homologous implementation for `emit` that subclasses can use to emit events.
+ */
+export declare class EmitterLikeBase<E extends Events> implements EmitterLike<E> {
+    protected readonly emitter: EventEmitter;
+    on<Event extends keyof E>(event: Event, handler: E[Event]): this;
+    /**
+     * Emits the event with the given arguments.
+     *
+     * @param event The event. This needs to be a key of the events type associated with this class.
+     * @param args The arguments to pass to the event handler. The types are inferred from the
+     * handler associated with the event in the events type associated with this class.
+     *
+     * @returns Whether the event is being listened to.
+     */
+    protected emit<Event extends keyof E>(event: Event, ...args: Parameters<E[Event]>): boolean;
+}

package/lib/cjs/events.js

@@ -0,0 +1,37 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmitterLikeBase = void 0;
+const node_events_1 = __importDefault(require("node:events"));
+/**
+ * A generic implementation of {@link EmitterLike}.
+ *
+ * Classes that want to implement the {@link EmitterLike} interface using a NodeJs
+ * event emitter can do so by extending this class.
+ *
+ * It simply delegates `on` calls to the underlying event emitter. It also provides
+ * an homologous implementation for `emit` that subclasses can use to emit events.
+ */
+class EmitterLikeBase {
+    emitter = new node_events_1.default();
+    on(event, handler) {
+        this.emitter.on(event.toString(), handler);
+        return this;
+    }
+    /**
+     * Emits the event with the given arguments.
+     *
+     * @param event The event. This needs to be a key of the events type associated with this class.
+     * @param args The arguments to pass to the event handler. The types are inferred from the
+     * handler associated with the event in the events type associated with this class.
+     *
+     * @returns Whether the event is being listened to.
+     */
+    emit(event, ...args) {
+        return this.emitter.emit(event.toString(), ...args);
+    }
+}
+exports.EmitterLikeBase = EmitterLikeBase;
+//# sourceMappingURL=events.js.map

package/lib/cjs/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/events.ts"],"names":[],"mappings":";;;;;;AAAA,8DAAuC;AA4BvC;;;;;;;;GAQG;AACH,MAAa,eAAe;IACP,OAAO,GAAG,IAAI,qBAAY,EAAE,CAAC;IAEhD,EAAE,CAAwB,KAAY,EAAE,OAAiB;QACvD,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACO,IAAI,CACZ,KAAY,EACZ,GAAG,IAA0B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;IACtD,CAAC;CACF;AAvBD,0CAuBC"}

package/lib/cjs/func.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Convenient type to easily represent "callable" types and to avoid using
+ * "any" in client code.
+ */
+export type Callable = (...args: never[]) => unknown;
+/**
+ * Convenient type alias for constructors.
+ */
+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 convenient type declaration for handlers used to resolve "error" type events.
+ */
+export type ErrorHandler<T extends Error = Error> = (err: T) => void;

package/lib/cjs/func.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=func.js.map

package/lib/cjs/func.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"func.js","sourceRoot":"","sources":["../../src/func.ts"],"names":[],"mappings":""}

package/lib/cjs/guard.d.ts

@@ -0,0 +1,44 @@
+/**
+ * A convenient Typescript type guard function to assess that a value is a string.
+ *
+ * @remark
+ * This function is mostly meant as a Typescript type guard. See:
+ * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
+ *
+ * @param value - The value to test.
+ * @returns Whether or not the value is a string.
+ */
+export declare function isString(value: unknown): value is string;
+/**
+ * A convenient Typescript type guard function to assess that a value is a symbol.
+ *
+ * @remark
+ * This function is mostly meant as a Typescript type guard. See:
+ * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
+ *
+ * @param value - The value to test.
+ * @returns Whether or not the value is a symbol.
+ */
+export declare function isSymbol(value: unknown): value is symbol;
+/**
+ * A convenient Typescript type guard function to assess that a value is a number.
+ *
+ * @remark
+ * This function is mostly meant as a Typescript type guard. See:
+ * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
+ *
+ * @param value - The value to test.
+ * @returns Whether or not the value is a number.
+ */
+export declare function isNumber(value: unknown): value is number;
+/**
+ * A convenient Typescript type guard function to assess that a value is a function.
+ *
+ * @remark
+ * * This function is mostly meant as a Typescript type guard. See:
+ * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
+ *
+ * @param value - The value to test.
+ * @returns Whether or not the value is a function.
+ */
+export declare function isFunction(value: unknown): value is Function;

package/lib/cjs/guard.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isFunction = exports.isNumber = exports.isSymbol = exports.isString = void 0;
+/**
+ * A convenient Typescript type guard function to assess that a value is a string.
+ *
+ * @remark
+ * This function is mostly meant as a Typescript type guard. See:
+ * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
+ *
+ * @param value - The value to test.
+ * @returns Whether or not the value is a string.
+ */
+function isString(value) {
+    return typeof value === "string";
+}
+exports.isString = isString;
+/**
+ * A convenient Typescript type guard function to assess that a value is a symbol.
+ *
+ * @remark
+ * This function is mostly meant as a Typescript type guard. See:
+ * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
+ *
+ * @param value - The value to test.
+ * @returns Whether or not the value is a symbol.
+ */
+function isSymbol(value) {
+    return typeof value === "symbol";
+}
+exports.isSymbol = isSymbol;
+/**
+ * A convenient Typescript type guard function to assess that a value is a number.
+ *
+ * @remark
+ * This function is mostly meant as a Typescript type guard. See:
+ * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
+ *
+ * @param value - The value to test.
+ * @returns Whether or not the value is a number.
+ */
+function isNumber(value) {
+    return typeof value === "number";
+}
+exports.isNumber = isNumber;
+/**
+ * A convenient Typescript type guard function to assess that a value is a function.
+ *
+ * @remark
+ * * This function is mostly meant as a Typescript type guard. See:
+ * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
+ *
+ * @param value - The value to test.
+ * @returns Whether or not the value is a function.
+ */
+// eslint-disable-next-line @typescript-eslint/ban-types
+function isFunction(value) {
+    return typeof value === "function";
+}
+exports.isFunction = isFunction;
+//# sourceMappingURL=guard.js.map

package/lib/cjs/guard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"guard.js","sourceRoot":"","sources":["../../src/guard.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;GASG;AACH,SAAgB,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AACnC,CAAC;AAFD,4BAEC;AAED;;;;;;;;;GASG;AACH,SAAgB,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AACnC,CAAC;AAFD,4BAEC;AAED;;;;;;;;;GASG;AACH,SAAgB,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AACnC,CAAC;AAFD,4BAEC;AAED;;;;;;;;;GASG;AACH,wDAAwD;AACxD,SAAgB,UAAU,CAAC,KAAc;IACvC,OAAO,OAAO,KAAK,KAAK,UAAU,CAAC;AACrC,CAAC;AAFD,gCAEC"}

package/lib/cjs/index.d.ts

@@ -1,30 +1,12 @@
-/**
- * Convenient type to easily represent "callable" types and to avoid using
- * "any" in client code.
- */
-export type Callable = (...args: never[]) => unknown;
-/**
- * Convenient type alias for constructors.
- */
-export type Constructor<R = object, A extends any[] = any[]> = new (...args: A) => R;
+export * from "./func.js";
+export * from "./guard.js";
+export * from "./events.js";
 /**
  * Convenient type alias to regroup a type that can be T, null or undefined.
  *
  * Semantically the opposite of {@link NonNullable}.
  */
 export type Nullable<T> = T | null | undefined;
-/**
- * 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 convenient type declaration for handlers used to resolve "error" type events.
- */
-export type ErrorHandler<T extends Error = Error> = (err: T) => void;
 /**
  * A convenience type extractor to get the inner type of an array.
  *
@@ -39,6 +21,8 @@ export type UnpackedArray<T> = T extends (infer U)[] ? U : never;
  * It will cause compilation errors if T isn't a promise.
  *
  * See here: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-8.html
+ *
+ * @deprecated Use built-in {@link Awaited} instead.
  */
 export type UnpackedPromise<T> = T extends Promise<infer U> ? U : never;
 /**
@@ -58,47 +42,3 @@ export type TransitivePartial<T> = {
 export type KeyOfType<T, U> = {
     [P in keyof T]: T[P] extends U ? P : never;
 }[keyof T];
-/**
- * A convenient Typescript type guard function to assess that a value is a string.
- *
- * @remark
- * This function is mostly meant as a Typescript type guard. See:
- * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
- *
- * @param value - The value to test.
- * @returns Whether or not the value is a string.
- */
-export declare function isString(value: unknown): value is string;
-/**
- * A convenient Typescript type guard function to assess that a value is a symbol.
- *
- * @remark
- * This function is mostly meant as a Typescript type guard. See:
- * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
- *
- * @param value - The value to test.
- * @returns Whether or not the value is a symbol.
- */
-export declare function isSymbol(value: unknown): value is symbol;
-/**
- * A convenient Typescript type guard function to assess that a value is a number.
- *
- * @remark
- * This function is mostly meant as a Typescript type guard. See:
- * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
- *
- * @param value - The value to test.
- * @returns Whether or not the value is a number.
- */
-export declare function isNumber(value: unknown): value is number;
-/**
- * A convenient Typescript type guard function to assess that a value is a function.
- *
- * @remark
- * * This function is mostly meant as a Typescript type guard. See:
- * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
- *
- * @param value - The value to test.
- * @returns Whether or not the value is a function.
- */
-export declare function isFunction(value: unknown): value is Function;

package/lib/cjs/index.js

@@ -1,61 +1,20 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isFunction = exports.isNumber = exports.isSymbol = exports.isString = void 0;
-/**
- * A convenient Typescript type guard function to assess that a value is a string.
- *
- * @remark
- * This function is mostly meant as a Typescript type guard. See:
- * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
- *
- * @param value - The value to test.
- * @returns Whether or not the value is a string.
- */
-function isString(value) {
-    return typeof value === "string";
-}
-exports.isString = isString;
-/**
- * A convenient Typescript type guard function to assess that a value is a symbol.
- *
- * @remark
- * This function is mostly meant as a Typescript type guard. See:
- * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
- *
- * @param value - The value to test.
- * @returns Whether or not the value is a symbol.
- */
-function isSymbol(value) {
-    return typeof value === "symbol";
-}
-exports.isSymbol = isSymbol;
-/**
- * A convenient Typescript type guard function to assess that a value is a number.
- *
- * @remark
- * This function is mostly meant as a Typescript type guard. See:
- * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
- *
- * @param value - The value to test.
- * @returns Whether or not the value is a number.
- */
-function isNumber(value) {
-    return typeof value === "number";
-}
-exports.isNumber = isNumber;
-/**
- * A convenient Typescript type guard function to assess that a value is a function.
- *
- * @remark
- * * This function is mostly meant as a Typescript type guard. See:
- * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
- *
- * @param value - The value to test.
- * @returns Whether or not the value is a function.
- */
-// eslint-disable-next-line @typescript-eslint/ban-types
-function isFunction(value) {
-    return typeof value === "function";
-}
-exports.isFunction = isFunction;
+__exportStar(require("./func.js"), exports);
+__exportStar(require("./guard.js"), exports);
+__exportStar(require("./events.js"), exports);
 //# sourceMappingURL=index.js.map

package/lib/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AA6EA;;;;;;;;;GASG;AACH,SAAgB,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AACnC,CAAC;AAFD,4BAEC;AAED;;;;;;;;;GASG;AACH,SAAgB,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AACnC,CAAC;AAFD,4BAEC;AAED;;;;;;;;;GASG;AACH,SAAgB,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AACnC,CAAC;AAFD,4BAEC;AAED;;;;;;;;;GASG;AACH,wDAAwD;AACxD,SAAgB,UAAU,CAAC,KAAc;IACvC,OAAO,OAAO,KAAK,KAAK,UAAU,CAAC;AACrC,CAAC;AAFD,gCAEC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,6CAA2B;AAC3B,8CAA4B"}

package/lib/esm/events.d.ts

@@ -0,0 +1,48 @@
+/// <reference types="node" resolution-mode="require"/>
+import EventEmitter from "node:events";
+/**
+ * Describes the interface that "Event" types must implement.
+ *
+ * Every key must resolve to a callable that describes the type of the
+ * handler for the event.
+ */
+export type Events = {
+    [key: string]: (...args: any[]) => void;
+};
+/**
+ * An interface for classes that behave like event emitters.
+ *
+ * Those typically allow subscription to a very specific set of events but do not export
+ * the emitting capabilities.
+ */
+export interface EmitterLike<E extends Events> {
+    /**
+     * Subscribes a handler to the specific event type.
+     * @param event
+     * @param handler
+     */
+    on<Event extends keyof E>(event: Event, handler: E[Event]): this;
+}
+/**
+ * A generic implementation of {@link EmitterLike}.
+ *
+ * Classes that want to implement the {@link EmitterLike} interface using a NodeJs
+ * event emitter can do so by extending this class.
+ *
+ * It simply delegates `on` calls to the underlying event emitter. It also provides
+ * an homologous implementation for `emit` that subclasses can use to emit events.
+ */
+export declare class EmitterLikeBase<E extends Events> implements EmitterLike<E> {
+    protected readonly emitter: EventEmitter;
+    on<Event extends keyof E>(event: Event, handler: E[Event]): this;
+    /**
+     * Emits the event with the given arguments.
+     *
+     * @param event The event. This needs to be a key of the events type associated with this class.
+     * @param args The arguments to pass to the event handler. The types are inferred from the
+     * handler associated with the event in the events type associated with this class.
+     *
+     * @returns Whether the event is being listened to.
+     */
+    protected emit<Event extends keyof E>(event: Event, ...args: Parameters<E[Event]>): boolean;
+}

package/lib/esm/events.js

@@ -0,0 +1,30 @@
+import EventEmitter from "node:events";
+/**
+ * A generic implementation of {@link EmitterLike}.
+ *
+ * Classes that want to implement the {@link EmitterLike} interface using a NodeJs
+ * event emitter can do so by extending this class.
+ *
+ * It simply delegates `on` calls to the underlying event emitter. It also provides
+ * an homologous implementation for `emit` that subclasses can use to emit events.
+ */
+export class EmitterLikeBase {
+    emitter = new EventEmitter();
+    on(event, handler) {
+        this.emitter.on(event.toString(), handler);
+        return this;
+    }
+    /**
+     * Emits the event with the given arguments.
+     *
+     * @param event The event. This needs to be a key of the events type associated with this class.
+     * @param args The arguments to pass to the event handler. The types are inferred from the
+     * handler associated with the event in the events type associated with this class.
+     *
+     * @returns Whether the event is being listened to.
+     */
+    emit(event, ...args) {
+        return this.emitter.emit(event.toString(), ...args);
+    }
+}
+//# sourceMappingURL=events.js.map

package/lib/esm/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/events.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,aAAa,CAAC;AA4BvC;;;;;;;;GAQG;AACH,MAAM,OAAO,eAAe;IACP,OAAO,GAAG,IAAI,YAAY,EAAE,CAAC;IAEhD,EAAE,CAAwB,KAAY,EAAE,OAAiB;QACvD,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACO,IAAI,CACZ,KAAY,EACZ,GAAG,IAA0B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;IACtD,CAAC;CACF"}

package/lib/esm/func.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Convenient type to easily represent "callable" types and to avoid using
+ * "any" in client code.
+ */
+export type Callable = (...args: never[]) => unknown;
+/**
+ * Convenient type alias for constructors.
+ */
+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 convenient type declaration for handlers used to resolve "error" type events.
+ */
+export type ErrorHandler<T extends Error = Error> = (err: T) => void;

package/lib/esm/func.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=func.js.map

package/lib/esm/func.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"func.js","sourceRoot":"","sources":["../../src/func.ts"],"names":[],"mappings":""}

package/lib/esm/guard.d.ts

@@ -0,0 +1,44 @@
+/**
+ * A convenient Typescript type guard function to assess that a value is a string.
+ *
+ * @remark
+ * This function is mostly meant as a Typescript type guard. See:
+ * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
+ *
+ * @param value - The value to test.
+ * @returns Whether or not the value is a string.
+ */
+export declare function isString(value: unknown): value is string;
+/**
+ * A convenient Typescript type guard function to assess that a value is a symbol.
+ *
+ * @remark
+ * This function is mostly meant as a Typescript type guard. See:
+ * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
+ *
+ * @param value - The value to test.
+ * @returns Whether or not the value is a symbol.
+ */
+export declare function isSymbol(value: unknown): value is symbol;
+/**
+ * A convenient Typescript type guard function to assess that a value is a number.
+ *
+ * @remark
+ * This function is mostly meant as a Typescript type guard. See:
+ * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
+ *
+ * @param value - The value to test.
+ * @returns Whether or not the value is a number.
+ */
+export declare function isNumber(value: unknown): value is number;
+/**
+ * A convenient Typescript type guard function to assess that a value is a function.
+ *
+ * @remark
+ * * This function is mostly meant as a Typescript type guard. See:
+ * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
+ *
+ * @param value - The value to test.
+ * @returns Whether or not the value is a function.
+ */
+export declare function isFunction(value: unknown): value is Function;

package/lib/esm/guard.js

@@ -0,0 +1,54 @@
+/**
+ * A convenient Typescript type guard function to assess that a value is a string.
+ *
+ * @remark
+ * This function is mostly meant as a Typescript type guard. See:
+ * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
+ *
+ * @param value - The value to test.
+ * @returns Whether or not the value is a string.
+ */
+export function isString(value) {
+    return typeof value === "string";
+}
+/**
+ * A convenient Typescript type guard function to assess that a value is a symbol.
+ *
+ * @remark
+ * This function is mostly meant as a Typescript type guard. See:
+ * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
+ *
+ * @param value - The value to test.
+ * @returns Whether or not the value is a symbol.
+ */
+export function isSymbol(value) {
+    return typeof value === "symbol";
+}
+/**
+ * A convenient Typescript type guard function to assess that a value is a number.
+ *
+ * @remark
+ * This function is mostly meant as a Typescript type guard. See:
+ * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
+ *
+ * @param value - The value to test.
+ * @returns Whether or not the value is a number.
+ */
+export function isNumber(value) {
+    return typeof value === "number";
+}
+/**
+ * A convenient Typescript type guard function to assess that a value is a function.
+ *
+ * @remark
+ * * This function is mostly meant as a Typescript type guard. See:
+ * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
+ *
+ * @param value - The value to test.
+ * @returns Whether or not the value is a function.
+ */
+// eslint-disable-next-line @typescript-eslint/ban-types
+export function isFunction(value) {
+    return typeof value === "function";
+}
+//# sourceMappingURL=guard.js.map

package/lib/esm/guard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"guard.js","sourceRoot":"","sources":["../../src/guard.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AACnC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AACnC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AACnC,CAAC;AAED;;;;;;;;;GASG;AACH,wDAAwD;AACxD,MAAM,UAAU,UAAU,CAAC,KAAc;IACvC,OAAO,OAAO,KAAK,KAAK,UAAU,CAAC;AACrC,CAAC"}

package/lib/esm/index.d.ts

@@ -1,30 +1,12 @@
-/**
- * Convenient type to easily represent "callable" types and to avoid using
- * "any" in client code.
- */
-export type Callable = (...args: never[]) => unknown;
-/**
- * Convenient type alias for constructors.
- */
-export type Constructor<R = object, A extends any[] = any[]> = new (...args: A) => R;
+export * from "./func.js";
+export * from "./guard.js";
+export * from "./events.js";
 /**
  * Convenient type alias to regroup a type that can be T, null or undefined.
  *
  * Semantically the opposite of {@link NonNullable}.
  */
 export type Nullable<T> = T | null | undefined;
-/**
- * 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 convenient type declaration for handlers used to resolve "error" type events.
- */
-export type ErrorHandler<T extends Error = Error> = (err: T) => void;
 /**
  * A convenience type extractor to get the inner type of an array.
  *
@@ -39,6 +21,8 @@ export type UnpackedArray<T> = T extends (infer U)[] ? U : never;
  * It will cause compilation errors if T isn't a promise.
  *
  * See here: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-8.html
+ *
+ * @deprecated Use built-in {@link Awaited} instead.
  */
 export type UnpackedPromise<T> = T extends Promise<infer U> ? U : never;
 /**
@@ -58,47 +42,3 @@ export type TransitivePartial<T> = {
 export type KeyOfType<T, U> = {
     [P in keyof T]: T[P] extends U ? P : never;
 }[keyof T];
-/**
- * A convenient Typescript type guard function to assess that a value is a string.
- *
- * @remark
- * This function is mostly meant as a Typescript type guard. See:
- * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
- *
- * @param value - The value to test.
- * @returns Whether or not the value is a string.
- */
-export declare function isString(value: unknown): value is string;
-/**
- * A convenient Typescript type guard function to assess that a value is a symbol.
- *
- * @remark
- * This function is mostly meant as a Typescript type guard. See:
- * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
- *
- * @param value - The value to test.
- * @returns Whether or not the value is a symbol.
- */
-export declare function isSymbol(value: unknown): value is symbol;
-/**
- * A convenient Typescript type guard function to assess that a value is a number.
- *
- * @remark
- * This function is mostly meant as a Typescript type guard. See:
- * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
- *
- * @param value - The value to test.
- * @returns Whether or not the value is a number.
- */
-export declare function isNumber(value: unknown): value is number;
-/**
- * A convenient Typescript type guard function to assess that a value is a function.
- *
- * @remark
- * * This function is mostly meant as a Typescript type guard. See:
- * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
- *
- * @param value - The value to test.
- * @returns Whether or not the value is a function.
- */
-export declare function isFunction(value: unknown): value is Function;

package/lib/esm/index.js

@@ -1,54 +1,4 @@
-/**
- * A convenient Typescript type guard function to assess that a value is a string.
- *
- * @remark
- * This function is mostly meant as a Typescript type guard. See:
- * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
- *
- * @param value - The value to test.
- * @returns Whether or not the value is a string.
- */
-export function isString(value) {
-    return typeof value === "string";
-}
-/**
- * A convenient Typescript type guard function to assess that a value is a symbol.
- *
- * @remark
- * This function is mostly meant as a Typescript type guard. See:
- * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
- *
- * @param value - The value to test.
- * @returns Whether or not the value is a symbol.
- */
-export function isSymbol(value) {
-    return typeof value === "symbol";
-}
-/**
- * A convenient Typescript type guard function to assess that a value is a number.
- *
- * @remark
- * This function is mostly meant as a Typescript type guard. See:
- * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
- *
- * @param value - The value to test.
- * @returns Whether or not the value is a number.
- */
-export function isNumber(value) {
-    return typeof value === "number";
-}
-/**
- * A convenient Typescript type guard function to assess that a value is a function.
- *
- * @remark
- * * This function is mostly meant as a Typescript type guard. See:
- * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
- *
- * @param value - The value to test.
- * @returns Whether or not the value is a function.
- */
-// eslint-disable-next-line @typescript-eslint/ban-types
-export function isFunction(value) {
-    return typeof value === "function";
-}
+export * from "./func.js";
+export * from "./guard.js";
+export * from "./events.js";
 //# sourceMappingURL=index.js.map

package/lib/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AA6EA;;;;;;;;;GASG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AACnC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AACnC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AACnC,CAAC;AAED;;;;;;;;;GASG;AACH,wDAAwD;AACxD,MAAM,UAAU,UAAU,CAAC,KAAc;IACvC,OAAO,OAAO,KAAK,KAAK,UAAU,CAAC;AACrC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@infra-blocks/types",
-  "version": "0.6.0-alpha.1",
+  "version": "0.6.0-alpha.3",
   "description": "Typescript types utility package.",
   "keywords": [
     "type",
@@ -8,7 +8,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/infrastructure-blocks/ts-types.git"
+    "url": "https://github.com/infra-blocks/ts-types.git"
   },
   "license": "ISC",
   "author": "",
@@ -36,7 +36,7 @@
     "test:unit": "mocha --config test/unit/.mocharc.cjs 'test/unit/**/*.spec.ts'"
   },
   "devDependencies": {
-    "@infra-blocks/test": "^0.3.1",
+    "@infra-blocks/test": "^0.4.0",
     "@types/mocha": "^10.0.1",
     "@types/node": "^20.10.3",
     "@typescript-eslint/eslint-plugin": "^5.59.8",