@hkdigital/lib-sveltekit 0.0.46 → 0.0.47

package/README.md

@@ -29,9 +29,26 @@ pnpm add @hkdigital/lib-sveltekit
 
 ### Update
 
+We use a global installion of the `ncu` package to upgrade our `package.json`. Install `ncu` first if you don't have it yet
+
+```bash
+npm install -g npm-check-updates
+```
+
+Upgrading works as follows:
+
 ```bash
 ncu "@hkdigital/*" -u && pnpm install
 ```
+We use a wildcard to upgrade all installed `node_modules` in the scope `@hkdigital`.
+
+You can also add this command to your project's `package.json`. E.g. add the lines:
+
+```bash
+"scripts": {
+  "upgrade:hklib": "ncu '@hkdigital/*' -u && pnpm install",
+  "upgrade:all": "ncu -u && pnpm install"
+```
 
 ### Import JS & Svelte
 
@@ -107,5 +124,5 @@ npm publish --access public
 pnpm run publish:npm
 ```
 
-### Contribute
+## Contribute
 If your wish to contribute to this library, please contact us [HKdigital](https://hkdigital.nl/contact). Alternatively, the license permits you to fork the library and publish under an alternative name. Change the package name in [package.json](./package.json) to do so.

package/dist/classes/data/Selector.d.ts

@@ -11,18 +11,20 @@ export default class Selector {
     /**
      * Returns the first item from the list of items that matches the selector
      *
-     * @param {object[]|null} items
+     * @template {object} T
+     * @param {T[]|null} items
      *
-     * @returns {object|null} item or null if not found
+     * @returns {T|null} item or null if not found
      */
-    findFirst(items: object[] | null): object | null;
+    findFirst<T extends unknown>(items: T[] | null): T | null;
     /**
      * Returns all items from the list of items that match the selector
      *
-     * @param {object[]|null} items
+     * @template {object} T
+     * @param {T[]|null} items
      *
-     * @returns {object|null} item or null if not found
+     * @returns {T|null} item or null if not found
      */
-    findAll(items: object[] | null): object | null;
+    findAll<T extends unknown>(items: T[] | null): T | null;
     #private;
 }

package/dist/classes/data/Selector.js

@@ -53,9 +53,10 @@ export default class Selector {
 	/**
 	 * Returns the first item from the list of items that matches the selector
 	 *
-	 * @param {object[]|null} items
+	 * @template {object} T
+	 * @param {T[]|null} items
 	 *
-	 * @returns {object|null} item or null if not found
+	 * @returns {T|null} item or null if not found
 	 */
 	findFirst(items) {
 		if (!items) {
@@ -76,9 +77,10 @@ export default class Selector {
 	/**
 	 * Returns all items from the list of items that match the selector
 	 *
-	 * @param {object[]|null} items
+	 * @template {object} T
+	 * @param {T[]|null} items
 	 *
-	 * @returns {object|null} item or null if not found
+	 * @returns {T|null} item or null if not found
 	 */
 	findAll(items) {
 		const result = [];

package/dist/util/array/index.d.ts

@@ -135,22 +135,24 @@ export function sortByPathValue(items: any[], path: string[] | string, compareFn
  * Find the first item in the list of objects that matches the selector
  * - All items in the supplied array must be objects
  *
- * @param {object[]} arr
+ * @template {object} T
+ * @param {T[]} arr
  * @param {object|null} selector
  *
- * @returns {object|null} first matched item
+ * @returns {T|null} first matched item
  */
-export function findFirst(arr: object[], selector: object | null): object | null;
+export function findFirst<T extends unknown>(arr: T[], selector: object | null): T | null;
 /**
  * Returns all items from the list of items that match the selector
  * - All items in the supplied array must be objects
  *
- * @param {object[]} arr
+ * @template {object} T
+ * @param {T[]} arr
  * @param {object|null} selector
  *
- * @returns {object[]} matching items
+ * @returns {T[]} matching items
  */
-export function findAll(arr: object[], selector: object | null): object[];
+export function findAll<T extends unknown>(arr: T[], selector: object | null): T[];
 /**
  * Convert array to an object using a list of keys for each index
  *

package/dist/util/array/index.js

@@ -378,10 +378,11 @@ export function sortByPathValue(items, path, compareFn = smallestFirst) {
  * Find the first item in the list of objects that matches the selector
  * - All items in the supplied array must be objects
  *
- * @param {object[]} arr
+ * @template {object} T
+ * @param {T[]} arr
  * @param {object|null} selector
  *
- * @returns {object|null} first matched item
+ * @returns {T|null} first matched item
  */
 export function findFirst(arr, selector) {
 	const selectorObj = new Selector(selector);
@@ -395,10 +396,11 @@ export function findFirst(arr, selector) {
  * Returns all items from the list of items that match the selector
  * - All items in the supplied array must be objects
  *
- * @param {object[]} arr
+ * @template {object} T
+ * @param {T[]} arr
  * @param {object|null} selector
  *
- * @returns {object[]} matching items
+ * @returns {T[]} matching items
  */
 export function findAll(arr, selector) {
 	const selectorObj = new Selector(selector);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@hkdigital/lib-sveltekit",
-	"version": "0.0.46",
+	"version": "0.0.47",
 	"author": "Jens Kleinhout, HKdigital (https://hkdigital.nl)",
 	"license": "ISC",
 	"repository": {