@equinor/cpl-utils 0.0.3 → 0.0.5

package/dist/index.d.mts

@@ -1,3 +1,23 @@
+/**
+ * A function ensuring returning whether an item is undefined or not. If not undefined, it will exclude undefined from the type.
+ *
+ * @example
+ * const options: Option[] = [
+ *  { value: "1", label: "Item 1"},
+ *  { value: "2", label: "Item 2"},
+ *  { value: "3", label: "Item 3"},
+ * ]
+ *
+ * const selectedValues = ["1", "3"]
+ *
+ * const optionsFilteredBySelectedValues = selectedValues
+ *  .map(selectedValue => options.find(option => option.value === selectedValue))
+ *  // type will be (Option | undefined)[]
+ *  .filter(itemIsDefined)
+ *  // type will be Option[]
+ */
+declare function itemIsDefined<T>(item: T): item is Exclude<typeof item, undefined>;
+
 /**
  * A better typed `Object.prototype.objectHasOwnOroperty`. It helps TypeScript
  * infer types when an object has multiple types with different properties.
@@ -29,4 +49,4 @@
  */
 declare function objectHasOwnProperty<Key extends PropertyKey>(object: object, key: Key): object is Record<Key, unknown>;
 
-export { objectHasOwnProperty };
+export { itemIsDefined, objectHasOwnProperty };

package/dist/index.d.ts

@@ -1,3 +1,23 @@
+/**
+ * A function ensuring returning whether an item is undefined or not. If not undefined, it will exclude undefined from the type.
+ *
+ * @example
+ * const options: Option[] = [
+ *  { value: "1", label: "Item 1"},
+ *  { value: "2", label: "Item 2"},
+ *  { value: "3", label: "Item 3"},
+ * ]
+ *
+ * const selectedValues = ["1", "3"]
+ *
+ * const optionsFilteredBySelectedValues = selectedValues
+ *  .map(selectedValue => options.find(option => option.value === selectedValue))
+ *  // type will be (Option | undefined)[]
+ *  .filter(itemIsDefined)
+ *  // type will be Option[]
+ */
+declare function itemIsDefined<T>(item: T): item is Exclude<typeof item, undefined>;
+
 /**
  * A better typed `Object.prototype.objectHasOwnOroperty`. It helps TypeScript
  * infer types when an object has multiple types with different properties.
@@ -29,4 +49,4 @@
  */
 declare function objectHasOwnProperty<Key extends PropertyKey>(object: object, key: Key): object is Record<Key, unknown>;
 
-export { objectHasOwnProperty };
+export { itemIsDefined, objectHasOwnProperty };

package/dist/index.js

@@ -20,15 +20,22 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  itemIsDefined: () => itemIsDefined,
   objectHasOwnProperty: () => objectHasOwnProperty
 });
 module.exports = __toCommonJS(index_exports);
 
+// src/itemIsDefined.ts
+function itemIsDefined(item) {
+  return item !== void 0;
+}
+
 // src/objectHasOwnProperty.ts
 function objectHasOwnProperty(object, key) {
   return Object.prototype.hasOwnProperty.call(object, key);
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  itemIsDefined,
   objectHasOwnProperty
 });

package/dist/index.mjs

@@ -1,7 +1,13 @@
+// src/itemIsDefined.ts
+function itemIsDefined(item) {
+  return item !== void 0;
+}
+
 // src/objectHasOwnProperty.ts
 function objectHasOwnProperty(object, key) {
   return Object.prototype.hasOwnProperty.call(object, key);
 }
 export {
+  itemIsDefined,
   objectHasOwnProperty
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/cpl-utils",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "license": "MIT",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -9,14 +9,12 @@
     "dist/**"
   ],
   "devDependencies": {
-    "@storybook/react": "^8.5.2",
-    "@storybook/test": "^8.5.2",
-    "eslint": "^8.57.1",
+    "eslint": "^9.21.0",
     "tsup": "^8.3.6",
     "typedoc": "^0.27.6",
     "typedoc-plugin-markdown": "^4.4.1",
-    "eslint-config-custom": "0.0.6",
-    "tsconfig": "0.0.1"
+    "@equinor/cpl-eslint-config": "0.0.8",
+    "@equinor/cpl-typescript-config": "0.0.2"
   },
   "publishConfig": {
     "access": "public"
@@ -27,6 +25,7 @@
     "dev": "tsup src/index.ts --format esm,cjs --watch --dts --external react",
     "typedoc": "typedoc && rm ./typedoc/README.mdx",
     "typedoc:watch": "typedoc --watch --preserveWatchOutput",
-    "lint": "TIMING=1 eslint . --fix"
+    "lint": "TIMING=1 eslint . --fix",
+    "typecheck": "tsc --noEmit"
   }
 }