@dr.pogodin/js-utils 0.1.4 → 0.1.5

package/README.md

@@ -46,6 +46,12 @@ and used in the same way):
   — One year expressed in milliseconds.
 
 ### Types
+- `Extends<Base, T extends Base>` &mdash; Validates compile-time the type **T**
+  extends (is assignable to) the type **Base**; returns **T** if successful.
+- `Implements<Base, T extends Base & ...>` &mdash; Validates compile-time
+  the type **T** extends (is assignable to) the type **Base**, and also has
+  all (if any) optional fields defined in the **Base**; returns **T** if
+  the validation passes.
 - `ObjectKey` &mdash; **string** | **number** | **symbol** &mdash;
   The most generic valid type of an object key in TypeScript.
 

package/build/common/types.js

@@ -12,4 +12,18 @@ exports.assertEmptyObject = assertEmptyObject;
 function assertEmptyObject(object) {
   if (Object.keys(object).length) throw Error('The object is not empty');
 }
+
+/**
+ * Validates compile-time that the type T extends Base, and returns T.
+ *
+ * BEWARE: In the case Base has some optional fields missing in T, T still
+ * extends Base (as "extends" means T is assignable to Base)! The Implements
+ * util below also checks that T has all optional fields defined in Base.
+ */
+
+/**
+ * Validates compile-time that the type T extends (is assignable to) the type
+ * Base, and also that it has defined all (if any) optional fields defined in
+ * the Base. Returns T if the validation passes.
+ */
 //# sourceMappingURL=types.js.map

package/build/common/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":["assertEmptyObject","object","Object","keys","length","Error"],"sources":["../../src/types.ts"],"sourcesContent":["// Misc TypeScript-specific utilities.\n\n/** The most permissive object key type. */\nexport type ObjectKey = string | number | symbol;\n\n/** Asserts given object is empty, both compile- and run-time. */\nexport function assertEmptyObject(object: Record<ObjectKey, never>): void {\n  if (Object.keys(object).length) throw Error('The object is not empty');\n}\n"],"mappings":";;;;;;AAAA;;AAEA;;AAGA;AACO,SAASA,iBAAiBA,CAACC,MAAgC,EAAQ;EACxE,IAAIC,MAAM,CAACC,IAAI,CAACF,MAAM,CAAC,CAACG,MAAM,EAAE,MAAMC,KAAK,CAAC,yBAAyB,CAAC;AACxE","ignoreList":[]}
+{"version":3,"file":"types.js","names":["assertEmptyObject","object","Object","keys","length","Error"],"sources":["../../src/types.ts"],"sourcesContent":["// Misc TypeScript-specific utilities.\n\n/** The most permissive object key type. */\nexport type ObjectKey = string | number | symbol;\n\n/** Asserts given object is empty, both compile- and run-time. */\nexport function assertEmptyObject(object: Record<ObjectKey, never>): void {\n  if (Object.keys(object).length) throw Error('The object is not empty');\n}\n\n/**\n * Validates compile-time that the type T extends Base, and returns T.\n *\n * BEWARE: In the case Base has some optional fields missing in T, T still\n * extends Base (as \"extends\" means T is assignable to Base)! The Implements\n * util below also checks that T has all optional fields defined in Base.\n */\nexport type Extends<Base, T extends Base> = T;\n\n/**\n * Validates compile-time that the type T extends (is assignable to) the type\n * Base, and also that it has defined all (if any) optional fields defined in\n * the Base. Returns T if the validation passes.\n */\nexport type Implements<\n  Base,\n  T extends Required<T> extends Required<Base> ? Base : Required<Base>,\n> = T;\n"],"mappings":";;;;;;AAAA;;AAEA;;AAGA;AACO,SAASA,iBAAiBA,CAACC,MAAgC,EAAQ;EACxE,IAAIC,MAAM,CAACC,IAAI,CAACF,MAAM,CAAC,CAACG,MAAM,EAAE,MAAMC,KAAK,CAAC,yBAAyB,CAAC;AACxE;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA","ignoreList":[]}

package/build/module/types.js

@@ -6,4 +6,18 @@
 export function assertEmptyObject(object) {
   if (Object.keys(object).length) throw Error('The object is not empty');
 }
+
+/**
+ * Validates compile-time that the type T extends Base, and returns T.
+ *
+ * BEWARE: In the case Base has some optional fields missing in T, T still
+ * extends Base (as "extends" means T is assignable to Base)! The Implements
+ * util below also checks that T has all optional fields defined in Base.
+ */
+
+/**
+ * Validates compile-time that the type T extends (is assignable to) the type
+ * Base, and also that it has defined all (if any) optional fields defined in
+ * the Base. Returns T if the validation passes.
+ */
 //# sourceMappingURL=types.js.map

package/build/module/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":["assertEmptyObject","object","Object","keys","length","Error"],"sources":["../../src/types.ts"],"sourcesContent":["// Misc TypeScript-specific utilities.\n\n/** The most permissive object key type. */\nexport type ObjectKey = string | number | symbol;\n\n/** Asserts given object is empty, both compile- and run-time. */\nexport function assertEmptyObject(object: Record<ObjectKey, never>): void {\n  if (Object.keys(object).length) throw Error('The object is not empty');\n}\n"],"mappings":"AAAA;;AAEA;;AAGA;AACA,OAAO,SAASA,iBAAiBA,CAACC,MAAgC,EAAQ;EACxE,IAAIC,MAAM,CAACC,IAAI,CAACF,MAAM,CAAC,CAACG,MAAM,EAAE,MAAMC,KAAK,CAAC,yBAAyB,CAAC;AACxE","ignoreList":[]}
+{"version":3,"file":"types.js","names":["assertEmptyObject","object","Object","keys","length","Error"],"sources":["../../src/types.ts"],"sourcesContent":["// Misc TypeScript-specific utilities.\n\n/** The most permissive object key type. */\nexport type ObjectKey = string | number | symbol;\n\n/** Asserts given object is empty, both compile- and run-time. */\nexport function assertEmptyObject(object: Record<ObjectKey, never>): void {\n  if (Object.keys(object).length) throw Error('The object is not empty');\n}\n\n/**\n * Validates compile-time that the type T extends Base, and returns T.\n *\n * BEWARE: In the case Base has some optional fields missing in T, T still\n * extends Base (as \"extends\" means T is assignable to Base)! The Implements\n * util below also checks that T has all optional fields defined in Base.\n */\nexport type Extends<Base, T extends Base> = T;\n\n/**\n * Validates compile-time that the type T extends (is assignable to) the type\n * Base, and also that it has defined all (if any) optional fields defined in\n * the Base. Returns T if the validation passes.\n */\nexport type Implements<\n  Base,\n  T extends Required<T> extends Required<Base> ? Base : Required<Base>,\n> = T;\n"],"mappings":"AAAA;;AAEA;;AAGA;AACA,OAAO,SAASA,iBAAiBA,CAACC,MAAgC,EAAQ;EACxE,IAAIC,MAAM,CAACC,IAAI,CAACF,MAAM,CAAC,CAACG,MAAM,EAAE,MAAMC,KAAK,CAAC,yBAAyB,CAAC;AACxE;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA","ignoreList":[]}

package/build/types/types.d.ts

@@ -2,3 +2,17 @@
 export type ObjectKey = string | number | symbol;
 /** Asserts given object is empty, both compile- and run-time. */
 export declare function assertEmptyObject(object: Record<ObjectKey, never>): void;
+/**
+ * Validates compile-time that the type T extends Base, and returns T.
+ *
+ * BEWARE: In the case Base has some optional fields missing in T, T still
+ * extends Base (as "extends" means T is assignable to Base)! The Implements
+ * util below also checks that T has all optional fields defined in Base.
+ */
+export type Extends<Base, T extends Base> = T;
+/**
+ * Validates compile-time that the type T extends (is assignable to) the type
+ * Base, and also that it has defined all (if any) optional fields defined in
+ * the Base. Returns T if the validation passes.
+ */
+export type Implements<Base, T extends Required<T> extends Required<Base> ? Base : Required<Base>> = T;

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@dr.pogodin/js-utils",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "Collection of JavaScript (TypeScript) utilities.",
   "main": "./build/module/index.js",
   "module": "./build/module/index.js",
   "types": "./build/types/index.d.ts",
   "exports": {
-    "require": "./build/common/index.js",
     "types": "./build/types/index.d.ts",
+    "require": "./build/common/index.js",
     "default": "./build/module/index.js"
   },
   "scripts": {
@@ -43,15 +43,15 @@
     "@babel/plugin-transform-runtime": "^7.28.5",
     "@babel/preset-env": "^7.28.5",
     "@babel/preset-typescript": "^7.28.5",
-    "@dr.pogodin/eslint-configs": "^0.1.1",
-    "@tsconfig/recommended": "^1.0.10",
+    "@dr.pogodin/eslint-configs": "^0.1.2",
+    "@tsconfig/recommended": "^1.0.13",
     "@types/jest": "^30.0.0",
     "babel-jest": "^30.2.0",
     "babel-plugin-add-import-extension": "^1.6.0",
     "jest": "^30.2.0",
     "mockdate": "^3.0.5",
-    "rimraf": "^6.0.1",
-    "tstyche": "^5.0.0",
+    "rimraf": "^6.1.2",
+    "tstyche": "^5.0.1",
     "typescript": "^5.9.3"
   },
   "dependencies": {