c1db40b564
* added customer guides * fixes to sidebar * remove old customer registration guide * fix build error * generate files * run linter
50 lines
1.1 KiB
Plaintext
50 lines
1.1 KiB
Plaintext
---
|
|
sidebar_label: "Module Options"
|
|
---
|
|
|
|
import { Table } from "docs-ui"
|
|
|
|
export const metadata = {
|
|
title: `Tax Module Options`,
|
|
}
|
|
|
|
# {metadata.title}
|
|
|
|
In this document, you'll learn about the options of the Tax Module.
|
|
|
|
## providers
|
|
|
|
The `providers` option is an array of either tax provider modules, tax plugins, or path to a file that defines a tax provider.
|
|
|
|
When the Medusa application starts, these providers are registered and can be used to retrieve tax lines.
|
|
|
|
```js title="medusa-config.js"
|
|
const { Modules } = require("@medusajs/modules-sdk")
|
|
|
|
// ...
|
|
|
|
module.exports = defineConfig({
|
|
// ...
|
|
modules: {
|
|
[Modules.TAX]: {
|
|
resolve: "@medusajs/tax",
|
|
options: {
|
|
providers: [
|
|
{
|
|
resolve: "my-provider",
|
|
options: {
|
|
// ...
|
|
},
|
|
},
|
|
],
|
|
},
|
|
},
|
|
},
|
|
})
|
|
```
|
|
|
|
The objects in the array accept the following properties:
|
|
|
|
- `resolve`: A string indicating the package name of the tax provider module or the path to it relative to the `src` directory.
|
|
- `options`: An object of options to pass to the tax provider.
|