docs: general updates and fixes (#13374)

* docs: general updates and fixes

* fix lint errors
This commit is contained in:
Shahed Nasser
2025-09-02 09:07:07 +03:00
committed by GitHub
parent c717535ca2
commit 24199fa47a
25 changed files with 477 additions and 396 deletions

View File

@@ -6,7 +6,7 @@ export const metadata = {
# {metadata.title}
This document provides a reference to the `moduleIntegrationTestRunner` function provided by the `@medusajs/test-utils` package.
This is a reference to the `moduleIntegrationTestRunner` function provided by the `@medusajs/test-utils` package.
## Example
@@ -39,51 +39,59 @@ moduleIntegrationTestRunner<BlogModuleService>({
type: "`string`",
name: "moduleName",
description: "The module's name.",
optional: false
},
{
type: "DmlEntity[]",
name: "moduleModels",
description: "The module's data models.",
optional: false
},
{
type: "string",
name: "resolve",
description: "The path to the module relative to the `src` directory.",
optional: false
},
{
type: "`() => void`",
name: "testSuite",
description: "The Jest tests to run.",
optional: false
},
{
type: "DmlEntity[]",
name: "moduleModels",
description: "The module's data models.",
optional: true
},
{
type: "`Record<string, any>`",
name: "moduleOptions",
description: "Options to pass to the module.",
optional: true
},
{
type: "`Record<string, any>`",
name: "injectedDependencies",
description: "Dependencies to inject into the module's container. They key is the registration name, and the value is the instance of the dependency.",
description: "Dependencies to inject into the module's container. The key is the registration name, and the value is the instance of the dependency.",
optional: true
},
{
type: "`string`",
name: "schema",
description: "The PostgreSQL schema that the database is created in.",
optional: true
},
{
type: "`boolean`",
name: "debug",
description: "Whether to show database log messages.",
defaultValue: "false"
defaultValue: "false",
optional: true
},
{
type: "`string`",
name: "cwd",
description: "The current working directory. If not set, the directory that you run the test command from is considered the current working directory.",
optional: true
}
]
}
]}
sectionTitle="Parameters"
openedLevel={2}
/>
## Test Suite Parameters
@@ -151,4 +159,5 @@ The function passed to `testSuite` accepts the following parameters:
}
]}
sectionTitle="Test Suite Parameters"
openedLevel={2}
/>