chore(docs): Generated References (#7998)

Generated the following references:
- `medusa_config`
- `modules`
- `types`
This commit is contained in:
github-actions[bot]
2024-07-08 08:48:39 +00:00
committed by GitHub
parent 6c7a0129e3
commit d7d26aa3f4
9 changed files with 48 additions and 32 deletions

View File

@@ -10463,6 +10463,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/workflows/functions/workflows.transform/page.mdx",
"pathname": "/references/workflows/functions/workflows.transform"
},
{
"filePath": "/www/apps/resources/references/workflows/functions/workflows.when/page.mdx",
"pathname": "/references/workflows/functions/workflows.when"
},
{
"filePath": "/www/apps/resources/references/workflows/interfaces/workflows.StepExecutionContext/page.mdx",
"pathname": "/references/workflows/interfaces/workflows.StepExecutionContext"

View File

@@ -7931,6 +7931,13 @@ export const generatedSidebar = [
"path": "/references/workflows/transform",
"title": "transform",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/workflows/when",
"title": "when",
"children": []
}
]
}

View File

@@ -4083,5 +4083,10 @@ export const slugChanges = [
"origSlug": "/references/workflows/functions/workflows.transform",
"newSlug": "/references/workflows/transform",
"filePath": "/www/apps/resources/references/workflows/functions/workflows.transform/page.mdx"
},
{
"origSlug": "/references/workflows/functions/workflows.when",
"newSlug": "/references/workflows/when",
"filePath": "/www/apps/resources/references/workflows/functions/workflows.when/page.mdx"
}
]

View File

@@ -64,7 +64,7 @@ Make sure to create the PostgreSQL database before using it. You can check how t
```js title="medusa-config.js"
module.exports = defineConfig({
projectConfig: {
databaseName: process.env.DATABASE_NAME ||
databaseName: process.env.DATABASE_NAME ||
"medusa-store",
// ...
},
@@ -147,31 +147,6 @@ module.exports = defineConfig({
})
```
### databaseExtra
An object that includes additional configurations to pass to the database connection. You can pass any configuration. One defined configuration to pass is
`ssl` which enables support for TLS/SSL connections.
This is useful for production databases, which can be supported by setting the `rejectUnauthorized` attribute of `ssl` object to `false`.
During development, its recommended not to pass this option.
#### Example
```js title="medusa-config.js"
module.exports = defineConfig({
projectConfig: {
databaseExtra: process.env.NODE_ENV !== "development" ?
{ ssl: { rejectUnauthorized: false } } : {}
// ...
},
// ...
})
```
#### Properties
<TypeList types={[{"name":"ssl","type":"`object`","description":"Configure support for TLS/SSL connection","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"rejectUnauthorized","type":"`false`","description":"Whether to fail connection if the server certificate is verified against the list of supplied CAs and the hostname and no match is found.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="databaseExtra"/>
### databaseDriverOptions
An object that includes additional configurations to pass to the database connection for v2. You can pass any configuration. One defined configuration to pass is
@@ -220,7 +195,7 @@ For a local Redis installation, the connection URL should be `redis://localhost:
```js title="medusa-config.js"
module.exports = defineConfig({
projectConfig: {
redisUrl: process.env.REDIS_URL ||
redisUrl: process.env.REDIS_URL ||
"redis://localhost:6379",
// ...
},
@@ -257,7 +232,7 @@ for the list of available options.
module.exports = defineConfig({
projectConfig: {
redisOptions: {
connectionName: process.env.REDIS_CONNECTION_NAME ||
connectionName: process.env.REDIS_CONNECTION_NAME ||
"medusa",
}
// ...
@@ -362,7 +337,7 @@ Admin dashboard configurations.
```js title="medusa-config.js"
module.exports = defineConfig({
admin: {
backendUrl: process.env.MEDUSA_BACKEND_URL ||
backendUrl: process.env.MEDUSA_BACKEND_URL ||
"http://localhost:9000"
},
// ...

View File

@@ -14,3 +14,4 @@ This section of the documentation provides a reference to the utility functions
- [createWorkflow](../../workflows/functions/workflows.createWorkflow/page.mdx)
- [parallelize](../../workflows/functions/workflows.parallelize/page.mdx)
- [transform](../../workflows/functions/workflows.transform/page.mdx)
- [when](../../workflows/functions/workflows.when/page.mdx)

View File

@@ -0,0 +1,24 @@
---
slug: /references/workflows/when
sidebar_label: when
---
import { TypeList } from "docs-ui"
# when - Workflows API Reference
This documentation provides a reference to the `when` . It belongs to the `@medusajs/workflows-sdk` package.
## Type Parameters
<TypeList types={[{"name":"T","type":"`object` \\| [WorkflowData](../../types/workflows.WorkflowData/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Then","type":"`Function`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="when"/>
## Parameters
<TypeList types={[{"name":"values","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"condition","type":"ConditionFunction&#60;T&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="when"/>
## Returns
<TypeList types={[{"name":"then","type":"`ThenFunc`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="when"/>
<TypeList types={[{"name":"then","type":"`ThenFunc`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="when"/>