@infra-blocks/types 0.1.0

package/README.md

@@ -0,0 +1,24 @@
+# ts-types
+
+Small types utility library for Typescript.
+
+## Development
+
+### Repo init
+
+This repository leverages [nvm](https://github.com/nvm-sh/nvm) and users should have it installed in their local environment.
+In addition, it is recommended that users install a [shell hook](https://github.com/nvm-sh/nvm#deeper-shell-integration)
+so that `nvm use` is run upon changing into a project that utilises `nvm`.
+
+Upon checking out the repository, run the following commands:
+```shell
+nvm install
+npm install
+npm run compile
+npm run lint
+npm run test
+```
+
+### Package publication
+
+Package publication is done manually at the moment.

package/lib/index.d.ts

@@ -0,0 +1,91 @@
+/**
+ * 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 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.
+ *
+ * It will cause compilation errors if T isn't an array.
+ *
+ * See here: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-8.html
+ */
+export type UnpackedArray<T> = T extends (infer U)[] ? U : never;
+/**
+ * A convenience type extractor to get the inner type of a promise.
+ *
+ * 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
+ */
+export type UnpackedPromise<T> = T extends Promise<infer U> ? U : never;
+/**
+ * A convenience type mapping that transitively make partial fields optional.
+ *
+ * The built-in Partial type doesn't cover nested objects, this one does.
+ */
+export type TransitivePartial<T> = {
+    [K in keyof T]?: T[K] extends object ? TransitivePartial<T[K]> : T[K];
+};
+/**
+ * A convenience type mapping to extract keys of a type that are of a given type.
+ *
+ * For example, if you would like all the types of an object that are numbers, you could do
+ * KeyOfType<TheType, number>
+ */
+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/index.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=index.js.map

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@infra-blocks/types",
+  "version": "0.1.0",
+  "description": "Typescript types utility package.",
+  "exports": "./lib/index.js",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "lib/**/*.{js,d.ts}"
+  ],
+  "type": "module",
+  "scripts": {
+    "prepack": "npm run build",
+    "build": "npm run clean && tsc --project tsconfig.build.json",
+    "compile": "tsc",
+    "clean": "rm -rf lib && rm -f breather-infra-*.tgz",
+    "lint": "eslint --ext .js,.ts --max-warnings 0 .",
+    "test": "npm run test:unit",
+    "test:coverage": "nyc npm run test",
+    "test:coverage:lcov": "npx nyc --reporter=lcov npm run test",
+    "test:unit": "mocha --config test/unit/.mocharc.cjs 'test/unit/**/*.spec.ts'",
+    "test:integration": "mocha --config test/integration/.mocharc.js 'test/integration/**/*.spec.ts'"
+  },
+  "devDependencies": {
+    "@istanbuljs/nyc-config-typescript": "^1.0.2",
+    "@types/chai": "^4.3.5",
+    "@types/chai-as-promised": "^7.1.5",
+    "@types/mocha": "^10.0.1",
+    "@types/node": "^18.16.16",
+    "@types/sinon": "^10.0.15",
+    "@types/sinon-chai": "^3.2.9",
+    "@typescript-eslint/eslint-plugin": "^5.59.8",
+    "@typescript-eslint/parser": "^5.59.8",
+    "chai": "^4.3.7",
+    "chai-as-promised": "^7.1.1",
+    "eslint": "^8.41.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "mocha": "^10.2.0",
+    "nyc": "^15.1.0",
+    "prettier": "^2.8.8",
+    "sinon": "^15.1.0",
+    "sinon-chai": "^3.7.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.4"
+  },
+  "author": "",
+  "license": "ISC"
+}