@guillaume-docquier/tools-ts 8.4.3 → 8.5.0

package/README.md

@@ -106,13 +106,14 @@ consistent context, scopes, formatting, and redaction.
 Use these small utilities to keep common asynchronous and callback patterns
 consistent.
 
-| Export            | What it is                                 | Use it when                                                                     |
-| ----------------- | ------------------------------------------ | ------------------------------------------------------------------------------- |
-| `setTimeoutAsync` | Promise-based timeout helper.              | You want `await`-friendly delays that work in browser and Node environments.    |
-| `debounce`        | Creates a debounced callback.              | A repeated event should trigger work only after calls have settled for a delay. |
-| `noop`            | Synchronous no-op function.                | You need a safe default callback that intentionally does nothing.               |
-| `asyncNoop`       | Asynchronous no-op function.               | You need a safe default async callback or hook that resolves immediately.       |
-| `omit`            | Runtime equivalent of `Omit<TType, TKey>`. | You need to remove keys from an object.                                         |
+| Export            | What it is                                            | Use it when                                                                     |
+| ----------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------- |
+| `setTimeoutAsync` | Promise-based timeout helper.                         | You want `await`-friendly delays that work in browser and Node environments.    |
+| `debounce`        | Creates a debounced callback.                         | A repeated event should trigger work only after calls have settled for a delay. |
+| `noop`            | Synchronous no-op function.                           | You need a safe default callback that intentionally does nothing.               |
+| `asyncNoop`       | Asynchronous no-op function.                          | You need a safe default async callback or hook that resolves immediately.       |
+| `omit`            | Runtime equivalent of `Omit<TType, TKey>`.            | You need to remove keys from an object.                                         |
+| `indexBy`         | Indexes objects by a selected string-valued property. | You need to look up objects by a string key.                                    |
 
 ### Profiling
 

package/dist/entry.tools-ts.d.ts

@@ -38,3 +38,4 @@ export { Point2D, type XY } from "./measurements/Point2D.js";
 export { Point3D, type XYZ } from "./measurements/Point3D.js";
 export { Timer } from "./Timer.js";
 export { type Branded, branded, type Unbranded, type UnbrandedProperties, type DeepUnbranded } from "./Brand.js";
+export { indexBy } from "./indexBy.js";

package/dist/entry.tools-ts.js

@@ -32,4 +32,5 @@ export { Point2D } from "./measurements/Point2D.js";
 export { Point3D } from "./measurements/Point3D.js";
 export { Timer } from "./Timer.js";
 export { branded } from "./Brand.js";
+export { indexBy } from "./indexBy.js";
 //# sourceMappingURL=entry.tools-ts.js.map

package/dist/entry.tools-ts.js.map

@@ -1 +1 @@
-{"version":3,"file":"entry.tools-ts.js","sourceRoot":"","sources":["../src/entry.tools-ts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AACnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAA;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAI5C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AACtC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,MAAM,EAA8B,MAAM,aAAa,CAAA;AAChE,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AACtC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AAE3C,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAC5C,OAAO,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAA;AAClE,OAAO,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAA;AAC5E,OAAO,EAAE,sBAAsB,EAAE,MAAM,+CAA+C,CAAA;AAEtF,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAA;AAKvE,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,GAAG,EAAiB,MAAM,cAAc,CAAA;AAEjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAA;AAC7D,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC5D,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,EAAE,OAAO,EAAW,MAAM,2BAA2B,CAAA;AAC5D,OAAO,EAAE,OAAO,EAAY,MAAM,2BAA2B,CAAA;AAC7D,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,EAAgB,OAAO,EAAgE,MAAM,YAAY,CAAA"}
+{"version":3,"file":"entry.tools-ts.js","sourceRoot":"","sources":["../src/entry.tools-ts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AACnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAA;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAI5C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AACtC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,MAAM,EAA8B,MAAM,aAAa,CAAA;AAChE,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AACtC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AAE3C,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAC5C,OAAO,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAA;AAClE,OAAO,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAA;AAC5E,OAAO,EAAE,sBAAsB,EAAE,MAAM,+CAA+C,CAAA;AAEtF,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAA;AAKvE,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,GAAG,EAAiB,MAAM,cAAc,CAAA;AAEjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAA;AAC7D,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC5D,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,EAAE,OAAO,EAAW,MAAM,2BAA2B,CAAA;AAC5D,OAAO,EAAE,OAAO,EAAY,MAAM,2BAA2B,CAAA;AAC7D,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,EAAgB,OAAO,EAAgE,MAAM,YAAY,CAAA;AAChH,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA"}

package/dist/indexBy.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Indexes objects by a string-valued property.
+ *
+ * @example
+ * ```ts
+ * const users = [{ id: "alice", age: 12 }, { id: "bob", age: 34 }]
+ * const usersById = indexBy("id", users)
+ * // {
+ * //   alice: { id: "alice", age: 12 },
+ * //   bob: { id: "bob", age: 34 },
+ * // }
+ * ```
+ */
+export declare function indexBy<TProperty extends string, TElement extends Record<TProperty, string>>(property: TProperty, arrayOfObjects: readonly TElement[]): Record<TElement[TProperty], TElement>;

package/dist/indexBy.js

@@ -0,0 +1,22 @@
+/**
+ * Indexes objects by a string-valued property.
+ *
+ * @example
+ * ```ts
+ * const users = [{ id: "alice", age: 12 }, { id: "bob", age: 34 }]
+ * const usersById = indexBy("id", users)
+ * // {
+ * //   alice: { id: "alice", age: 12 },
+ * //   bob: { id: "bob", age: 34 },
+ * // }
+ * ```
+ */
+export function indexBy(property, arrayOfObjects) {
+    // oxlint-disable-next-line typescript/consistent-type-assertions typescript/no-unsafe-type-assertion -- Strange TS quirk?
+    const indexed = {};
+    for (const obj of arrayOfObjects) {
+        indexed[obj[property]] = obj;
+    }
+    return indexed;
+}
+//# sourceMappingURL=indexBy.js.map

package/dist/indexBy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexBy.js","sourceRoot":"","sources":["../src/indexBy.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,OAAO,CACrB,QAAmB,EACnB,cAAmC;IAEnC,0HAA0H;IAC1H,MAAM,OAAO,GAAG,EAA2C,CAAA;IAC3D,KAAK,MAAM,GAAG,IAAI,cAAc,EAAE,CAAC;QACjC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,GAAG,GAAG,CAAA;IAC9B,CAAC;IAED,OAAO,OAAO,CAAA;AAChB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guillaume-docquier/tools-ts",
-  "version": "8.4.3",
+  "version": "8.5.0",
   "description": "My personal collection of typescript tools",
   "homepage": "https://github.com/Guillaume-Docquier/tools-ts",
   "license": "MIT",