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

docs: general fixes and improvements (#7918)

Browse Source 
* 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
This commit is contained in:
Shahed Nasser
2024-07-04 17:26:03 +03:00
committed by GitHub
parent 32982e708a
commit 964927b597
149 changed files with 1676 additions and 3008 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/book/app/basics/loaders/page.mdx
+8 -12
View File
@@ -8,9 +8,7 @@ In this chapter, you’ll learn about loaders and how to use them.
## What is a Loader?
A loader is a function executed when the Medusa application starts.
A module can define loaders to execute on application start-up.
A loader is a function executed when the Medusa application starts. You define and export it in a module.
---
@@ -30,25 +28,23 @@ export default function helloWorldLoader() {
### Export Loader in Module Definition
You must export your loaders in the module definition.
To do that, import the loader in `src/modules/hello/index.ts` and export it in the module's definition:
Import the loader in `src/modules/hello/index.ts` and export it in the module's definition:
```ts title="src/modules/hello/index.ts"
// other imports...
import helloWorldLoader from "./loaders/hello-world"
// ...
export default {
export default Module("hello", {
// ...
loaders: [helloWorldLoader],
}
})
```
The value of the `loaders` property is an array of loader functions.
### Test Loader
---
## Test the Loader
Start the Medusa application:
@@ -75,6 +71,6 @@ Among the messages logged in the terminal, you’ll see the following message:
<Note title="Don't use loaders if" type="error">
- You want to perform an action continuously or at a set time pattern in the application. Use scheduled jobs instead, which is explained in the next chapter.
- You want to perform an action continuously or at a set time pattern in the application. Use scheduled jobs instead, which is explained in an upcoming chapter.
</Note>