chore(docs): Generated References (#8289)

Generated the following references:
- `fulfillment`
- `medusa_config`
- `modules`
- `order`
- `types`
This commit is contained in:
github-actions[bot]
2024-07-26 08:20:04 +00:00
committed by GitHub
parent f3274a7c5b
commit c6d6e3eff4
70 changed files with 64295 additions and 63894 deletions
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -0,0 +1,9 @@
---
displayed_sidebar: fulfillmentReference
---
import { TypeList } from "docs-ui"
# OrderReturnItemDTO
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_quantity","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"reason_id","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_received_quantity","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="OrderReturnItemDTO"/>
File diff suppressed because one or more lines are too long
@@ -281,20 +281,31 @@ module.exports = defineConfig({
### workerMode
Configure the application's worker mode. Default is `shared`.
Configure the application's worker mode.
Workers are processes running separately from the main application. They're useful for executing long-running or resource-heavy tasks in the background, such as importing products.
With a worker, these tasks are offloaded to a separate process. So, they won't affect the performance of the main application.
![Diagram showcasing how the server and worker work together](https://res.cloudinary.com/dza7lstvk/image/upload/fl\_lossy/f\_auto/r\_16/ar\_16:9,c\_pad/v1/Medusa%20Book/medusa-worker\_klkbch.jpg?\_a=BATFJtAA0)
Medusa has three runtime modes:
- Use `shared` to run the application in a single process.
- Use `worker` to run the a worker process only.
- Use `server` to run the application server only.
Learn more in [this guide](https://docs.medusajs.com/development/medusa-worker).
In production, it's recommended to deploy two instances:
1. One having the `workerMode` configuration set to `server`.
2. Another having the `workerMode` configuration set to `worker`.
#### Example
```js title="medusa-config.js"
module.exports = defineConfig({
projectConfig: {
workerMode: "shared"
workerMode: process.env.WORKER_MODE || "shared"
// ...
},
// ...
File diff suppressed because one or more lines are too long
@@ -76,6 +76,7 @@ import { TypeList } from "docs-ui"
- [OrderItemDTO](../../fulfillment/interfaces/fulfillment.OrderItemDTO/page.mdx)
- [OrderDTO](../../fulfillment/interfaces/fulfillment.OrderDTO/page.mdx)
- [ReturnDTO](../../fulfillment/interfaces/fulfillment.ReturnDTO/page.mdx)
- [OrderReturnItemDTO](../../fulfillment/interfaces/fulfillment.OrderReturnItemDTO/page.mdx)
- [OrderClaimDTO](../../fulfillment/interfaces/fulfillment.OrderClaimDTO/page.mdx)
- [OrderExchangeDTO](../../fulfillment/interfaces/fulfillment.OrderExchangeDTO/page.mdx)
- [OrderChangeDTO](../../fulfillment/interfaces/fulfillment.OrderChangeDTO/page.mdx)
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long