Files
medusa-store/www/apps/docs/content/references/js-client/interfaces/internal-8.JoinerServiceConfig.md
github-actions[bot] daea35fe73 chore(docs): Generated JS Client Reference (#5334)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-10-10 17:47:07 +00:00

1.6 KiB

displayed_sidebar
displayed_sidebar
jsClientSidebar

Interface: JoinerServiceConfig

internal.JoinerServiceConfig

Properties

alias

Optional alias: JoinerServiceConfigAlias | JoinerServiceConfigAlias[]

Property name to use as entrypoint to the service

Defined in

packages/types/dist/joiner/index.d.ts:36


args

Optional args: Record<string, any>

Extra arguments to pass to the remoteFetchData callback

Defined in

packages/types/dist/joiner/index.d.ts:53


extends

Optional extends: { relationship: JoinerRelationship ; serviceName: string }[]

Defined in

packages/types/dist/joiner/index.d.ts:46


fieldAlias

Optional fieldAlias: Record<string, string | { forwardArgumentsOnPath: string[] ; path: string }>

alias for deeper nested relationships (e.g. { 'price': 'prices.calculated_price_set.amount' })

Defined in

packages/types/dist/joiner/index.d.ts:40


primaryKeys

primaryKeys: string[]

Defined in

packages/types/dist/joiner/index.d.ts:44


relationships

Optional relationships: JoinerRelationship[]

Defined in

packages/types/dist/joiner/index.d.ts:45


serviceName

serviceName: string

Defined in

packages/types/dist/joiner/index.d.ts:32