docs: Caching Module (#13701)

* standard docs for caching module + deprecated cache module

* added guides for creating + using, and overall changes from cache to caching

* fix details related to redis provider

* fix build errors

* fix build error

* fixes

* add guides to sidebar

* add sidebar util

* document query + index

* moved cache tag conventions

* fix build errors

* added migration guide

* added memcached guide

* fixes

* general fixes and updates

* updated reference

* document medusa cache

* small fix

* fixes

* remove cloud cache

* revert edit dates changes

* revert edit dates

* small update
This commit is contained in:
Shahed Nasser
2025-10-21 10:34:27 +03:00
committed by GitHub
parent eefda0edce
commit 76f9da5ef4
50 changed files with 10530 additions and 145 deletions

View File

@@ -1,19 +1,19 @@
{
"id": 61101,
"id": 0,
"name": "cache",
"variant": "project",
"kind": 1,
"flags": {},
"children": [
{
"id": 61102,
"id": 1,
"name": "ICacheService",
"variant": "declaration",
"kind": 256,
"flags": {},
"children": [
{
"id": 61103,
"id": 2,
"name": "get",
"variant": "declaration",
"kind": 2048,
@@ -23,12 +23,12 @@
"fileName": "service.ts",
"line": 11,
"character": 2,
"url": "https://github.com/medusajs/medusa/blob/a503bbe5963f95710f599c466dfb2c3956914e06/packages/core/types/src/cache/service.ts#L11"
"url": "https://github.com/medusajs/medusa/blob/54cf8811af626df63b1b093561bd0337d1f786eb/packages/core/types/src/cache/service.ts#L11"
}
],
"signatures": [
{
"id": 61104,
"id": 3,
"name": "get",
"variant": "signature",
"kind": 4096,
@@ -66,12 +66,12 @@
"fileName": "service.ts",
"line": 11,
"character": 2,
"url": "https://github.com/medusajs/medusa/blob/a503bbe5963f95710f599c466dfb2c3956914e06/packages/core/types/src/cache/service.ts#L11"
"url": "https://github.com/medusajs/medusa/blob/54cf8811af626df63b1b093561bd0337d1f786eb/packages/core/types/src/cache/service.ts#L11"
}
],
"typeParameters": [
{
"id": 61105,
"id": 4,
"name": "T",
"variant": "typeParam",
"kind": 131072,
@@ -80,7 +80,7 @@
],
"parameters": [
{
"id": 61106,
"id": 5,
"name": "key",
"variant": "param",
"kind": 32768,
@@ -115,7 +115,7 @@
},
{
"type": "reference",
"target": 61105,
"target": 4,
"name": "T",
"package": "@medusajs/types",
"refersToTypeParameter": true
@@ -130,7 +130,7 @@
]
},
{
"id": 61107,
"id": 6,
"name": "set",
"variant": "declaration",
"kind": 2048,
@@ -140,12 +140,12 @@
"fileName": "service.ts",
"line": 22,
"character": 2,
"url": "https://github.com/medusajs/medusa/blob/a503bbe5963f95710f599c466dfb2c3956914e06/packages/core/types/src/cache/service.ts#L22"
"url": "https://github.com/medusajs/medusa/blob/54cf8811af626df63b1b093561bd0337d1f786eb/packages/core/types/src/cache/service.ts#L22"
}
],
"signatures": [
{
"id": 61108,
"id": 7,
"name": "set",
"variant": "signature",
"kind": 4096,
@@ -174,12 +174,12 @@
"fileName": "service.ts",
"line": 22,
"character": 2,
"url": "https://github.com/medusajs/medusa/blob/a503bbe5963f95710f599c466dfb2c3956914e06/packages/core/types/src/cache/service.ts#L22"
"url": "https://github.com/medusajs/medusa/blob/54cf8811af626df63b1b093561bd0337d1f786eb/packages/core/types/src/cache/service.ts#L22"
}
],
"parameters": [
{
"id": 61109,
"id": 8,
"name": "key",
"variant": "param",
"kind": 32768,
@@ -198,7 +198,7 @@
}
},
{
"id": 61110,
"id": 9,
"name": "data",
"variant": "param",
"kind": 32768,
@@ -217,7 +217,7 @@
}
},
{
"id": 61111,
"id": 10,
"name": "ttl",
"variant": "param",
"kind": 32768,
@@ -257,7 +257,7 @@
]
},
{
"id": 61112,
"id": 11,
"name": "invalidate",
"variant": "declaration",
"kind": 2048,
@@ -267,12 +267,12 @@
"fileName": "service.ts",
"line": 31,
"character": 2,
"url": "https://github.com/medusajs/medusa/blob/a503bbe5963f95710f599c466dfb2c3956914e06/packages/core/types/src/cache/service.ts#L31"
"url": "https://github.com/medusajs/medusa/blob/54cf8811af626df63b1b093561bd0337d1f786eb/packages/core/types/src/cache/service.ts#L31"
}
],
"signatures": [
{
"id": 61113,
"id": 12,
"name": "invalidate",
"variant": "signature",
"kind": 4096,
@@ -301,12 +301,12 @@
"fileName": "service.ts",
"line": 31,
"character": 2,
"url": "https://github.com/medusajs/medusa/blob/a503bbe5963f95710f599c466dfb2c3956914e06/packages/core/types/src/cache/service.ts#L31"
"url": "https://github.com/medusajs/medusa/blob/54cf8811af626df63b1b093561bd0337d1f786eb/packages/core/types/src/cache/service.ts#L31"
}
],
"parameters": [
{
"id": 61114,
"id": 13,
"name": "key",
"variant": "param",
"kind": 32768,
@@ -348,9 +348,9 @@
{
"title": "Methods",
"children": [
61103,
61107,
61112
2,
6,
11
]
}
],
@@ -359,7 +359,7 @@
"fileName": "service.ts",
"line": 1,
"character": 17,
"url": "https://github.com/medusajs/medusa/blob/a503bbe5963f95710f599c466dfb2c3956914e06/packages/core/types/src/cache/service.ts#L1"
"url": "https://github.com/medusajs/medusa/blob/54cf8811af626df63b1b093561bd0337d1f786eb/packages/core/types/src/cache/service.ts#L1"
}
]
}
@@ -368,65 +368,65 @@
{
"title": "Interfaces",
"children": [
61102
1
]
}
],
"packageName": "@medusajs/types",
"symbolIdMap": {
"61101": {
"0": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": ""
},
"61102": {
"1": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": "ICacheService"
},
"61103": {
"2": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": "ICacheService.get"
},
"61104": {
"3": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": "ICacheService.get"
},
"61105": {
"4": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": "T"
},
"61106": {
"5": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": "key"
},
"61107": {
"6": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": "ICacheService.set"
},
"61108": {
"7": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": "ICacheService.set"
},
"61109": {
"8": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": "key"
},
"61110": {
"9": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": "data"
},
"61111": {
"10": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": "ttl"
},
"61112": {
"11": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": "ICacheService.invalidate"
},
"61113": {
"12": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": "ICacheService.invalidate"
},
"61114": {
"13": {
"sourceFileName": "../../../../packages/core/types/src/cache/service.ts",
"qualifiedName": "key"
}
@@ -436,7 +436,7 @@
"1": "../../../../packages/core/types/src/cache/service.ts"
},
"reflections": {
"1": 61101
"1": 0
}
}
}

File diff suppressed because it is too large Load Diff