@algolia/client-common 5.48.0 → 5.48.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/common.d.cts CHANGED
@@ -255,10 +255,18 @@ type TransporterOptions = {
255
255
  */
256
256
  requester: Requester;
257
257
  /**
258
- * The cache of the requests. When requests are
259
- * `cacheable`, the returned promised persists
260
- * in this cache to shared in similar requests
261
- * before being resolved.
258
+ * Cache used to store in-flight requests.
259
+ * When a request is marked as `cacheable`, its returned Promise
260
+ * is stored in this cache so that identical requests can share
261
+ * the same Promise before it resolves.
262
+ *
263
+ * @warning
264
+ * The provided cache **must not** serialize stored values.
265
+ *
266
+ * Since in-flight requests are stored as Promises (which cannot be
267
+ * serialized to JSON), using a serializing cache will cause failures.
268
+ *
269
+ * Make sure to use a non-serializing cache implementation, such as `createMemoryCache({ serializable: false })` or to disable request caching with `createNullCache()`
262
270
  */
263
271
  requestsCache: Cache;
264
272
  /**
package/dist/common.d.ts CHANGED
@@ -255,10 +255,18 @@ type TransporterOptions = {
255
255
  */
256
256
  requester: Requester;
257
257
  /**
258
- * The cache of the requests. When requests are
259
- * `cacheable`, the returned promised persists
260
- * in this cache to shared in similar requests
261
- * before being resolved.
258
+ * Cache used to store in-flight requests.
259
+ * When a request is marked as `cacheable`, its returned Promise
260
+ * is stored in this cache so that identical requests can share
261
+ * the same Promise before it resolves.
262
+ *
263
+ * @warning
264
+ * The provided cache **must not** serialize stored values.
265
+ *
266
+ * Since in-flight requests are stored as Promises (which cannot be
267
+ * serialized to JSON), using a serializing cache will cause failures.
268
+ *
269
+ * Make sure to use a non-serializing cache implementation, such as `createMemoryCache({ serializable: false })` or to disable request caching with `createNullCache()`
262
270
  */
263
271
  requestsCache: Cache;
264
272
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@algolia/client-common",
3
- "version": "5.48.0",
3
+ "version": "5.48.2",
4
4
  "description": "Common package for the Algolia JavaScript API client.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -36,7 +36,7 @@
36
36
  },
37
37
  "devDependencies": {
38
38
  "@arethetypeswrong/cli": "0.18.2",
39
- "@types/node": "24.10.9",
39
+ "@types/node": "24.10.12",
40
40
  "jsdom": "27.4.0",
41
41
  "publint": "0.3.17",
42
42
  "ts-node": "10.9.2",
@@ -47,5 +47,5 @@
47
47
  "engines": {
48
48
  "node": ">= 14.0.0"
49
49
  },
50
- "gitHead": "b39976bd859ef66e65d2db182d69853a91a71139"
50
+ "gitHead": "8785b7ec18363b229b0202a75e3770d9d1d1bd6f"
51
51
  }