2d74ec256f
* docs: change format of module reference * description fix * update structure + comments * added new options to README * small text fix * change section ordering * change how required/optional are shown * remove optional text * docs: redesigned accordion
12 lines
1.4 KiB
Plaintext
12 lines
1.4 KiB
Plaintext
---
|
|
displayed_sidebar: pricingReference
|
|
---
|
|
|
|
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":"","children":[]},{"name":"args","type":"Record<`string`, `any`\\>","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","children":[]},{"name":"extends","type":"{ `relationship`: [`JoinerRelationship`](../types/JoinerRelationship.mdx) ; `serviceName`: `string` }[]","description":"","optional":true,"defaultValue":"","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":"","children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":false,"defaultValue":"","children":[]},{"name":"relationships","type":"[`JoinerRelationship`](../types/JoinerRelationship.mdx)[]","description":"","optional":true,"defaultValue":"","children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","children":[]}]} />
|