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
108 lines
2.5 KiB
Plaintext
108 lines
2.5 KiB
Plaintext
import { CodeTabs, CodeTab } from "docs-ui"
|
||
|
||
export const metadata = {
|
||
title: `Examples of the Currency Module`,
|
||
}
|
||
|
||
# {metadata.title}
|
||
|
||
In this guide, you’ll find common examples of how you can use the Currency Module in your application.
|
||
|
||
## List Currencies
|
||
|
||
<CodeTabs groupId="app-type">
|
||
<CodeTab label="Medusa API Router" value="medusa">
|
||
|
||
```ts
|
||
import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
|
||
import { ICurrencyModuleService } from "@medusajs/types"
|
||
import { ModuleRegistrationName } from "@medusajs/utils"
|
||
|
||
export async function GET(
|
||
req: MedusaRequest,
|
||
res: MedusaResponse
|
||
): Promise<void> {
|
||
const currencyModuleService: ICurrencyModuleService = req.scope.resolve(
|
||
ModuleRegistrationName.CURRENCY
|
||
)
|
||
|
||
res.json({
|
||
currencies: await currencyModuleService.listCurrencies(),
|
||
})
|
||
}
|
||
```
|
||
|
||
</CodeTab>
|
||
<CodeTab label="Next.js App Router" value="nextjs">
|
||
|
||
```ts
|
||
import { NextResponse } from "next/server"
|
||
|
||
import { initialize as initializeCurrencyModule } from "@medusajs/currency"
|
||
|
||
export async function GET(request: Request) {
|
||
const currencyModuleService = await initializeCurrencyModule()
|
||
|
||
return NextResponse.json({
|
||
currencies: await currencyModuleService.listCurrencies(),
|
||
})
|
||
}
|
||
```
|
||
|
||
</CodeTab>
|
||
</CodeTabs>
|
||
|
||
---
|
||
|
||
## Retrieve a Currency by its Code
|
||
|
||
<CodeTabs groupId="app-type">
|
||
<CodeTab label="Medusa API Router" value="medusa">
|
||
|
||
```ts
|
||
import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
|
||
import { ICurrencyModuleService } from "@medusajs/types"
|
||
import { ModuleRegistrationName } from "@medusajs/utils"
|
||
|
||
export async function GET(
|
||
req: MedusaRequest,
|
||
res: MedusaResponse
|
||
): Promise<void> {
|
||
const currencyModuleService: ICurrencyModuleService = req.scope.resolve(
|
||
ModuleRegistrationName.CURRENCY
|
||
)
|
||
|
||
const currency = await currencyModuleService.retrieveCurrency("usd")
|
||
|
||
res.json({
|
||
currency,
|
||
})
|
||
}
|
||
```
|
||
|
||
</CodeTab>
|
||
<CodeTab label="Next.js App Router" value="nextjs">
|
||
|
||
```ts
|
||
import { NextResponse } from "next/server"
|
||
|
||
import { initialize as initializeCurrencyModule } from "@medusajs/currency"
|
||
|
||
export async function GET(request: Request) {
|
||
const currencyModuleService = await initializeCurrencyModule()
|
||
|
||
const currency = await currencyModuleService.retrieveCurrency("usd")
|
||
|
||
return NextResponse.json({ currency })
|
||
}
|
||
```
|
||
|
||
</CodeTab>
|
||
</CodeTabs>
|
||
|
||
---
|
||
|
||
## More Examples
|
||
|
||
The [Currency Module's main service reference](/references/currency) provides a reference to all the methods available for use with examples for each.
|