964927b597
* docs improvements and changes * updated module definition * modules + dml changes * fix build * fix vale error * fix lint errors * fixes to stripe docs * fix condition * fix condition * fix module defintion * fix checkout * disable UI action * change oas preview action * flatten provider module options * fix lint errors * add module link docs * pr comments fixes * fix vale error * change node engine version * links -> linkable * add note about database name * small fixes * link fixes * fix response code in api reference * added migrations step
103 lines
2.4 KiB
Plaintext
103 lines
2.4 KiB
Plaintext
import { CodeTabs, CodeTab } from "docs-ui"
|
||
|
||
export const metadata = {
|
||
title: `${pageNumber} Module Options`,
|
||
}
|
||
|
||
# {metadata.title}
|
||
|
||
In this chapter, you’ll learn about passing options to your module from the Medusa application’s configurations and using them in the module’s resources.
|
||
|
||
## What are Module Options?
|
||
|
||
A module can receive options to customize or configure its functionality.
|
||
|
||
For example, if you’re creating a module that integrates a third-party service, you’ll want to receive the integration credentials in the options rather than adding them directly in your code.
|
||
|
||
---
|
||
|
||
## How to Pass Options to a Module?
|
||
|
||
To pass options to a module, add an `options` property to the module’s configuration in `medusa-config.js`.
|
||
|
||
For example:
|
||
|
||
```js title="medusa-config.js"
|
||
module.exports = defineConfig({
|
||
// ...
|
||
modules: {
|
||
helloModuleService: {
|
||
resolve: "./modules/hello",
|
||
options: {
|
||
capitalize: true,
|
||
},
|
||
},
|
||
},
|
||
})
|
||
```
|
||
|
||
The `options` property’s value is an object. You can pass any properties you want.
|
||
|
||
---
|
||
|
||
## Access Module Options in Main Service
|
||
|
||
The module’s main service receives the module options as a second parameter.
|
||
|
||
For example:
|
||
|
||
```ts title="src/modules/hello/service.ts" highlights={[["12"], ["14", "options?: ModuleOptions"], ["17"], ["18"], ["19"]]}
|
||
import { MedusaService } from "@medusajs/utils"
|
||
import MyCustom from "./models/my-custom"
|
||
|
||
// recommended to define type in another file
|
||
type ModuleOptions = {
|
||
capitalize?: boolean
|
||
}
|
||
|
||
export default class HelloModuleService extends MedusaService({
|
||
MyCustom,
|
||
}){
|
||
protected options_: ModuleOptions
|
||
|
||
constructor({}, options?: ModuleOptions) {
|
||
super(...arguments)
|
||
|
||
this.options_ = options || {
|
||
capitalize: false,
|
||
}
|
||
}
|
||
|
||
// ...
|
||
}
|
||
```
|
||
|
||
---
|
||
|
||
## Access Module Options in Loader
|
||
|
||
The object that a module’s loaders receive as a parameter has an `options` property holding the module's options.
|
||
|
||
For example:
|
||
|
||
```ts title="src/modules/hello/loaders/hello-world.ts" highlights={[["11"], ["12", "ModuleOptions", "The type of expected module options."], ["16"]]}
|
||
import {
|
||
LoaderOptions,
|
||
} from "@medusajs/modules-sdk"
|
||
|
||
// recommended to define type in another file
|
||
type ModuleOptions = {
|
||
capitalize?: boolean
|
||
}
|
||
|
||
export default function helloWorldLoader({
|
||
options,
|
||
}: LoaderOptions<ModuleOptions>) {
|
||
|
||
console.log(
|
||
"[HELLO MODULE] Just started the Medusa application!",
|
||
options
|
||
)
|
||
}
|
||
```
|