asyavee/medusa-store
1
0 Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

chore(docs): Generated References (#6351)

Browse Source 
Generated the following references:
- `file`
- `fulfillment`
- `inventory`
- `js_client`
- `medusa`
- `medusa_config`
- `medusa_react`
- `modules`
- `notification`
- `payment`
- `price_selection`
- `pricing`
- `product`
- `services`
- `stock_location`
- `tax`
- `tax_calculation`
- `types`
- `workflows`

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andShahed Nasser authored and GitHub committed 2024-02-08 21:18:10 +00:00
1 parent e56c440911
commit 1d0a978ffe
343 files changed
+92337 -73600
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs-util/typedoc-json-output/0-medusa.json
+18068 -17638
View File
File diff suppressed because it is too large. Load diff
docs-util/typedoc-json-output/0-types.json
+32914 -18399
View File
File diff suppressed because it is too large. Load diff
docs-util/typedoc-json-output/file.json
+28 -8
View File
@@ -1420,11 +1420,21 @@
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../packages/types/src/common/medusa-container.ts",
"qualifiedName": "MedusaContainer"
"sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Record"
},
"name": "MedusaContainer",
"package": "@medusajs/types"
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "unknown"
}
],
"name": "Record",
"package": "typescript"
}
},
{
@@ -1511,11 +1521,21 @@
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../packages/types/src/common/medusa-container.ts",
"qualifiedName": "MedusaContainer"
"sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Record"
},
"name": "MedusaContainer",
"package": "@medusajs/types"
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "unknown"
}
],
"name": "Record",
"package": "typescript"
}
},
{
docs-util/typedoc-json-output/fulfillment.json
+28 -8
View File
@@ -2469,11 +2469,21 @@
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../packages/types/src/common/medusa-container.ts",
"qualifiedName": "MedusaContainer"
"sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Record"
},
"name": "MedusaContainer",
"package": "@medusajs/types"
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "unknown"
}
],
"name": "Record",
"package": "typescript"
}
},
{
@@ -2560,11 +2570,21 @@
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../packages/types/src/common/medusa-container.ts",
"qualifiedName": "MedusaContainer"
"sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Record"
},
"name": "MedusaContainer",
"package": "@medusajs/types"
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "unknown"
}
],
"name": "Record",
"package": "typescript"
}
},
{
docs-util/typedoc-json-output/inventory.json
+1162 -1121
View File
File diff suppressed because it is too large. Load diff
docs-util/typedoc-json-output/medusa-config.json
+63 -26
View File
@@ -1158,6 +1158,38 @@
"name": "HttpCompressionOptions",
"package": "@medusajs/types"
}
},
{
"id": 26,
"name": "jobs_batch_size",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Configure the number of staged jobs that are polled from the database. Default is 1000."
}
],
"blockTags": [
{
"tag": "@example",
"content": [
{
"kind": "code",
"text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n jobs_batch_size: 100\n // ...\n },\n // ...\n}\n```"
}
]
}
]
},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"groups": [
@@ -1177,13 +1209,14 @@
22,
23,
24,
25
25,
26
]
}
]
},
{
"id": 26,
"id": 27,
"name": "ConfigModule",
"variant": "declaration",
"kind": 256,
@@ -1214,7 +1247,7 @@
"kind": "inline-tag",
"tag": "@link",
"text": "projectConfig",
"target": 27,
"target": 28,
"tsLinkText": "projectConfig"
},
{
@@ -1225,7 +1258,7 @@
"kind": "inline-tag",
"tag": "@link",
"text": "plugins",
"target": 28,
"target": 29,
"tsLinkText": "plugins"
},
{
@@ -1236,7 +1269,7 @@
"kind": "inline-tag",
"tag": "@link",
"text": "modules",
"target": 32,
"target": 33,
"tsLinkText": "modules"
},
{
@@ -1247,7 +1280,7 @@
"kind": "inline-tag",
"tag": "@link",
"text": "featureFlags",
"target": 33,
"target": 34,
"tsLinkText": "featureFlags"
},
{
@@ -1282,7 +1315,7 @@
},
"children": [
{
"id": 27,
"id": 28,
"name": "projectConfig",
"variant": "declaration",
"kind": 1024,
@@ -1303,7 +1336,7 @@
}
},
{
"id": 28,
"id": 29,
"name": "plugins",
"variant": "declaration",
"kind": 1024,
@@ -1371,14 +1404,14 @@
{
"type": "reflection",
"declaration": {
"id": 29,
"id": 30,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 30,
"id": 31,
"name": "resolve",
"variant": "declaration",
"kind": 1024,
@@ -1389,7 +1422,7 @@
}
},
{
"id": 31,
"id": 32,
"name": "options",
"variant": "declaration",
"kind": 1024,
@@ -1419,8 +1452,8 @@
{
"title": "Properties",
"children": [
30,
31
31,
32
]
}
]
@@ -1431,7 +1464,7 @@
}
},
{
"id": 32,
"id": 33,
"name": "modules",
"variant": "declaration",
"kind": 1024,
@@ -1605,7 +1638,7 @@
}
},
{
"id": 33,
"id": 34,
"name": "featureFlags",
"variant": "declaration",
"kind": 1024,
@@ -1683,10 +1716,10 @@
{
"title": "Properties",
"children": [
27,
28,
32,
33
29,
33,
34
]
}
]
@@ -1698,7 +1731,7 @@
"children": [
1,
6,
26
27
]
}
],
@@ -1806,33 +1839,37 @@
},
"26": {
"sourceFileName": "../../../packages/types/src/common/config-module.ts",
"qualifiedName": "ConfigModule"
"qualifiedName": "__type.jobs_batch_size"
},
"27": {
"sourceFileName": "../../../packages/types/src/common/config-module.ts",
"qualifiedName": "__type.projectConfig"
"qualifiedName": "ConfigModule"
},
"28": {
"sourceFileName": "../../../packages/types/src/common/config-module.ts",
"qualifiedName": "__type.plugins"
"qualifiedName": "__type.projectConfig"
},
"29": {
"sourceFileName": "../../../packages/types/src/common/config-module.ts",
"qualifiedName": "__type"
"qualifiedName": "__type.plugins"
},
"30": {
"sourceFileName": "../../../packages/types/src/common/config-module.ts",
"qualifiedName": "__type.resolve"
"qualifiedName": "__type"
},
"31": {
"sourceFileName": "../../../packages/types/src/common/config-module.ts",
"qualifiedName": "__type.options"
"qualifiedName": "__type.resolve"
},
"32": {
"sourceFileName": "../../../packages/types/src/common/config-module.ts",
"qualifiedName": "__type.modules"
"qualifiedName": "__type.options"
},
"33": {
"sourceFileName": "../../../packages/types/src/common/config-module.ts",
"qualifiedName": "__type.modules"
},
"34": {
"sourceFileName": "../../../packages/types/src/common/config-module.ts",
"qualifiedName": "__type.featureFlags"
}
docs-util/typedoc-json-output/medusa-react.json
+18057 -17760
View File
File diff suppressed because it is too large. Load diff
docs-util/typedoc-json-output/notification.json
+28 -8
View File
@@ -1422,11 +1422,21 @@
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../packages/types/src/common/medusa-container.ts",
"qualifiedName": "MedusaContainer"
"sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Record"
},
"name": "MedusaContainer",
"package": "@medusajs/types"
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "unknown"
}
],
"name": "Record",
"package": "typescript"
}
},
{
@@ -1513,11 +1523,21 @@
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../packages/types/src/common/medusa-container.ts",
"qualifiedName": "MedusaContainer"
"sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Record"
},
"name": "MedusaContainer",
"package": "@medusajs/types"
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "unknown"
}
],
"name": "Record",
"package": "typescript"
}
},
{
docs-util/typedoc-json-output/payment.json
+28 -8
View File
@@ -2369,11 +2369,21 @@
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../packages/medusa-core-utils/dist/medusa-container.d.ts",
"qualifiedName": "MedusaContainer"
"sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Record"
},
"name": "MedusaContainer",
"package": "medusa-core-utils"
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "unknown"
}
],
"name": "Record",
"package": "typescript"
}
},
{
@@ -2450,11 +2460,21 @@
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../packages/medusa-core-utils/dist/medusa-container.d.ts",
"qualifiedName": "MedusaContainer"
"sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Record"
},
"name": "MedusaContainer",
"package": "medusa-core-utils"
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "unknown"
}
],
"name": "Record",
"package": "typescript"
}
},
{
docs-util/typedoc-json-output/price-selection.json
+28 -8
View File
@@ -474,11 +474,21 @@
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../packages/types/src/common/medusa-container.ts",
"qualifiedName": "MedusaContainer"
"sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Record"
},
"name": "MedusaContainer",
"package": "@medusajs/types"
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "unknown"
}
],
"name": "Record",
"package": "typescript"
}
},
{
@@ -565,11 +575,21 @@
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../packages/types/src/common/medusa-container.ts",
"qualifiedName": "MedusaContainer"
"sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Record"
},
"name": "MedusaContainer",
"package": "@medusajs/types"
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "unknown"
}
],
"name": "Record",
"package": "typescript"
}
},
{
docs-util/typedoc-json-output/pricing.json
+2814 -1939
View File
File diff suppressed because it is too large. Load diff
docs-util/typedoc-json-output/product.json
+3004 -2283
View File
File diff suppressed because it is too large. Load diff
docs-util/typedoc-json-output/services.json
+13088 -12940
View File
File diff suppressed because it is too large. Load diff
docs-util/typedoc-json-output/stock-location.json
+689 -622
View File
File diff suppressed because it is too large. Load diff
docs-util/typedoc-json-output/tax-calculation.json
+28 -8
View File
@@ -311,11 +311,21 @@
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../packages/types/src/common/medusa-container.ts",
"qualifiedName": "MedusaContainer"
"sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Record"
},
"name": "MedusaContainer",
"package": "@medusajs/types"
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "unknown"
}
],
"name": "Record",
"package": "typescript"
}
},
{
@@ -402,11 +412,21 @@
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../packages/types/src/common/medusa-container.ts",
"qualifiedName": "MedusaContainer"
"sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Record"
},
"name": "MedusaContainer",
"package": "@medusajs/types"
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "unknown"
}
],
"name": "Record",
"package": "typescript"
}
},
{
docs-util/typedoc-json-output/tax.json
+28 -8
View File
@@ -755,11 +755,21 @@
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../packages/types/src/common/medusa-container.ts",
"qualifiedName": "MedusaContainer"
"sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Record"
},
"name": "MedusaContainer",
"package": "@medusajs/types"
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "unknown"
}
],
"name": "Record",
"package": "typescript"
}
},
{
@@ -846,11 +856,21 @@
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../packages/types/src/common/medusa-container.ts",
"qualifiedName": "MedusaContainer"
"sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Record"
},
"name": "MedusaContainer",
"package": "@medusajs/types"
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "unknown"
}
],
"name": "Record",
"package": "typescript"
}
},
{