@medusajs/types 3.0.0-snapshot-20251201170954 → 3.0.0-snapshot-20251202134037
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/caching/index.d.ts +18 -18
- package/package.json +2 -2
package/dist/caching/index.d.ts
CHANGED
|
@@ -11,7 +11,7 @@ type Providers = (string | {
|
|
|
11
11
|
ttl?: number;
|
|
12
12
|
})[];
|
|
13
13
|
/**
|
|
14
|
-
* @since
|
|
14
|
+
* @since 2.11.0
|
|
15
15
|
*/
|
|
16
16
|
export interface ICachingModuleService extends IModuleService {
|
|
17
17
|
/**
|
|
@@ -24,7 +24,7 @@ export interface ICachingModuleService extends IModuleService {
|
|
|
24
24
|
* To retrieve by key:
|
|
25
25
|
*
|
|
26
26
|
* ```ts
|
|
27
|
-
* const data = await
|
|
27
|
+
* const data = await cachingModuleService.get({
|
|
28
28
|
* key: "products", // this key would typically be a hash
|
|
29
29
|
* }) as { id: string; title: string; }
|
|
30
30
|
* ```
|
|
@@ -32,7 +32,7 @@ export interface ICachingModuleService extends IModuleService {
|
|
|
32
32
|
* To retrieve by tags:
|
|
33
33
|
*
|
|
34
34
|
* ```ts
|
|
35
|
-
* const data = await
|
|
35
|
+
* const data = await cachingModuleService.get({
|
|
36
36
|
* tags: ["Product:list:*"],
|
|
37
37
|
* }) as { id: string; title: string; }[]
|
|
38
38
|
* ```
|
|
@@ -40,7 +40,7 @@ export interface ICachingModuleService extends IModuleService {
|
|
|
40
40
|
* To retrieve by key from specific providers:
|
|
41
41
|
*
|
|
42
42
|
* ```ts
|
|
43
|
-
* const data = await
|
|
43
|
+
* const data = await cachingModuleService.get({
|
|
44
44
|
* key: "products", // this key would typically be a hash
|
|
45
45
|
* providers: ["caching-redis", "caching-memcached"]
|
|
46
46
|
* }) as { id: string; title: string; }
|
|
@@ -78,8 +78,8 @@ export interface ICachingModuleService extends IModuleService {
|
|
|
78
78
|
*
|
|
79
79
|
* ```ts
|
|
80
80
|
* const data = { id: "prod_123", title: "Product 123" }
|
|
81
|
-
* const key = await
|
|
82
|
-
* await
|
|
81
|
+
* const key = await cachingModuleService.computeKey(data)
|
|
82
|
+
* await cachingModuleService.set({
|
|
83
83
|
* key,
|
|
84
84
|
* data
|
|
85
85
|
* })
|
|
@@ -95,8 +95,8 @@ export interface ICachingModuleService extends IModuleService {
|
|
|
95
95
|
*
|
|
96
96
|
* ```ts
|
|
97
97
|
* const data = [{ id: "prod_123", title: "Product 123" }]
|
|
98
|
-
* const key = await
|
|
99
|
-
* await
|
|
98
|
+
* const key = await cachingModuleService.computeKey(data)
|
|
99
|
+
* await cachingModuleService.set({
|
|
100
100
|
* key,
|
|
101
101
|
* data,
|
|
102
102
|
* tags: [`Product:${data[0].id}`, "Product:list:*"]
|
|
@@ -107,8 +107,8 @@ export interface ICachingModuleService extends IModuleService {
|
|
|
107
107
|
*
|
|
108
108
|
* ```ts
|
|
109
109
|
* const data = [{ id: "prod_123", title: "Product 123" }]
|
|
110
|
-
* const key = await
|
|
111
|
-
* await
|
|
110
|
+
* const key = await cachingModuleService.computeKey(data)
|
|
111
|
+
* await cachingModuleService.set({
|
|
112
112
|
* key,
|
|
113
113
|
* data,
|
|
114
114
|
* options: { autoInvalidate: false }
|
|
@@ -121,8 +121,8 @@ export interface ICachingModuleService extends IModuleService {
|
|
|
121
121
|
*
|
|
122
122
|
* ```ts
|
|
123
123
|
* const data = { id: "prod_123", title: "Product 123" }
|
|
124
|
-
* const key = await
|
|
125
|
-
* await
|
|
124
|
+
* const key = await cachingModuleService.computeKey(data)
|
|
125
|
+
* await cachingModuleService.set({
|
|
126
126
|
* key,
|
|
127
127
|
* data,
|
|
128
128
|
* providers: [
|
|
@@ -188,7 +188,7 @@ export interface ICachingModuleService extends IModuleService {
|
|
|
188
188
|
* To invalidate cache by key:
|
|
189
189
|
*
|
|
190
190
|
* ```ts
|
|
191
|
-
* await
|
|
191
|
+
* await cachingModuleService.clear({
|
|
192
192
|
* key: "products" // this key would typically be a hash
|
|
193
193
|
* })
|
|
194
194
|
* ```
|
|
@@ -198,7 +198,7 @@ export interface ICachingModuleService extends IModuleService {
|
|
|
198
198
|
* To invalidate cache by tags:
|
|
199
199
|
*
|
|
200
200
|
* ```ts
|
|
201
|
-
* await
|
|
201
|
+
* await cachingModuleService.clear({
|
|
202
202
|
* tags: ["Product:list:*"]
|
|
203
203
|
* })
|
|
204
204
|
* ```
|
|
@@ -208,7 +208,7 @@ export interface ICachingModuleService extends IModuleService {
|
|
|
208
208
|
* To invalidate only the cache data that were set to automatically invalidate:
|
|
209
209
|
*
|
|
210
210
|
* ```ts
|
|
211
|
-
* await
|
|
211
|
+
* await cachingModuleService.clear({
|
|
212
212
|
* tags: ["Product:list:*"],
|
|
213
213
|
* options: { autoInvalidate: true }
|
|
214
214
|
* })
|
|
@@ -227,7 +227,7 @@ export interface ICachingModuleService extends IModuleService {
|
|
|
227
227
|
* To invalidate cache from specific providers:
|
|
228
228
|
*
|
|
229
229
|
* ```ts
|
|
230
|
-
* await
|
|
230
|
+
* await cachingModuleService.clear({
|
|
231
231
|
* key: "products",
|
|
232
232
|
* providers: ["caching-redis", "caching-memcached"]
|
|
233
233
|
* })
|
|
@@ -269,7 +269,7 @@ export interface ICachingModuleService extends IModuleService {
|
|
|
269
269
|
* @returns The computed cache key.
|
|
270
270
|
*
|
|
271
271
|
* @example
|
|
272
|
-
* const key = await
|
|
272
|
+
* const key = await cachingModuleService.computeKey({
|
|
273
273
|
* id: "prod_123",
|
|
274
274
|
* title: "Product 123"
|
|
275
275
|
* })
|
|
@@ -284,7 +284,7 @@ export interface ICachingModuleService extends IModuleService {
|
|
|
284
284
|
* @returns An array of computed cache tags.
|
|
285
285
|
*
|
|
286
286
|
* @example
|
|
287
|
-
* const tags = await
|
|
287
|
+
* const tags = await cachingModuleService.computeTags({
|
|
288
288
|
* products: [{ id: "prod_123" }, { id: "prod_456" }],
|
|
289
289
|
* }, {
|
|
290
290
|
* operation: "updated"
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@medusajs/types",
|
|
3
|
-
"version": "3.0.0-snapshot-
|
|
3
|
+
"version": "3.0.0-snapshot-20251202134037",
|
|
4
4
|
"description": "Medusa Types definition",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
"bignumber.js": "^9.1.2"
|
|
36
36
|
},
|
|
37
37
|
"devDependencies": {
|
|
38
|
-
"@medusajs/deps": "3.0.0-snapshot-
|
|
38
|
+
"@medusajs/deps": "3.0.0-snapshot-20251202134037"
|
|
39
39
|
},
|
|
40
40
|
"peerDependencies": {
|
|
41
41
|
"ioredis": "^5.4.1",
|