Files
medusa-store/www/apps/docs/content/references/services/interfaces/JoinerServiceConfig.mdx
github-actions[bot] 39649b3552 chore(docs): Generated References (#5602)
Generated the following references:
- `pricing`
- `product`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-11-10 17:31:02 +00:00

76 lines
1.9 KiB
Plaintext

---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# JoinerServiceConfig
## Properties
<ParameterTypes parameters={[
{
"name": "alias",
"type": "[`JoinerServiceConfigAlias`](JoinerServiceConfigAlias.mdx) \\| [`JoinerServiceConfigAlias`](JoinerServiceConfigAlias.mdx)[]",
"description": "Property name to use as entrypoint to the service",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "args",
"type": "Record<`string`, `any`\\>",
"description": "Extra arguments to pass to the remoteFetchData callback",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "extends",
"type": "{ `relationship`: [`JoinerRelationship`](../types/JoinerRelationship.mdx) ; `serviceName`: `string` }[]",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fieldAlias",
"type": "Record<`string`, `string` \\| { `forwardArgumentsOnPath`: `string`[] ; `path`: `string` }\\>",
"description": "alias for deeper nested relationships (e.g. { 'price': 'prices.calculated_price_set.amount' })",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "primaryKeys",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "relationships",
"type": "[`JoinerRelationship`](../types/JoinerRelationship.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "serviceName",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />