@clipboard-health/util-ts 1.1.0 → 1.2.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [1.2.0](https://github.com/ClipboardHealth/cbh-core/compare/util-ts-1.1.0...util-ts-1.2.0) (2024-05-08)
+
+
+### Features
+
+* add more utils ([#624](https://github.com/ClipboardHealth/cbh-core/issues/624)) ([282ec68](https://github.com/ClipboardHealth/cbh-core/commit/282ec68d285ac0007032eb57d5e16177ef380e30))
+
 ## [1.1.0](https://github.com/ClipboardHealth/cbh-core/compare/util-ts-1.0.0...util-ts-1.1.0) (2024-01-24)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clipboard-health/util-ts",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "main": "./src/index.js",
   "scripts": {
     "build": "nx build util-ts",

package/src/lib/null-to-undefined.d.ts

@@ -1,2 +1,11 @@
-export declare function nullToUndefined<T>(value: Promise<T | null>): Promise<T | undefined>;
+/**
+ * Turns a null-returning promise into a promise returning undefined.
+ *
+ * Some of the database packages that we use return promises (Prisma)
+ * or promise-like objects (mongoose) that can resolve to null.
+ * This function is useful for getting rid of nulls which are banned by our linter rules.
+ *
+ * @param value A promise or a promise-like object.
+ */
+export declare function nullToUndefined<T>(value: PromiseLike<T | null>): Promise<T | undefined>;
 //# sourceMappingURL=null-to-undefined.d.ts.map

package/src/lib/null-to-undefined.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"null-to-undefined.d.ts","sourceRoot":"","sources":["../../../../../packages/util-ts/src/lib/null-to-undefined.ts"],"names":[],"mappings":"AACA,wBAAsB,eAAe,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAEzF"}
+{"version":3,"file":"null-to-undefined.d.ts","sourceRoot":"","sources":["../../../../../packages/util-ts/src/lib/null-to-undefined.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,wBAAsB,eAAe,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAE7F"}

package/src/lib/null-to-undefined.js

@@ -1,6 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.nullToUndefined = void 0;
+/**
+ * Turns a null-returning promise into a promise returning undefined.
+ *
+ * Some of the database packages that we use return promises (Prisma)
+ * or promise-like objects (mongoose) that can resolve to null.
+ * This function is useful for getting rid of nulls which are banned by our linter rules.
+ *
+ * @param value A promise or a promise-like object.
+ */
 // eslint-disable-next-line @typescript-eslint/ban-types
 async function nullToUndefined(value) {
     return (await value) ?? undefined;

package/src/lib/null-to-undefined.js.map

@@ -1 +1 @@
-{"version":3,"file":"null-to-undefined.js","sourceRoot":"","sources":["../../../../../packages/util-ts/src/lib/null-to-undefined.ts"],"names":[],"mappings":";;;AAAA,wDAAwD;AACjD,KAAK,UAAU,eAAe,CAAI,KAAwB;IAC/D,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,SAAS,CAAC;AACpC,CAAC;AAFD,0CAEC"}
+{"version":3,"file":"null-to-undefined.js","sourceRoot":"","sources":["../../../../../packages/util-ts/src/lib/null-to-undefined.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;GAQG;AACH,wDAAwD;AACjD,KAAK,UAAU,eAAe,CAAI,KAA4B;IACnE,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,SAAS,CAAC;AACpC,CAAC;AAFD,0CAEC"}