docs: add additional data description in generated references (#10944)
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
1b86c17b72
commit
2a2b387bc3
917 files changed
+15807
-15158
No files matched your search
+1
-1
@@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"messageData","type":"[RawMessageFormat](../../../types/store.RawMessageFormat/page.mdx)<T> \\| [RawMessageFormat](../../../types/store.RawMessageFormat/page.mdx)<T>[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"source","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"source","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"Pick<[Context](../../../interfaces/store.Context/page.mdx), \"eventGroupId\">","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, any>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"Pick<[Context](../../../interfaces/store.Context/page.mdx), \"eventGroupId\">","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, any>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="saveRawMessageData"/>
|
||||
<TypeList types={[{"name":"messageData","type":"[RawMessageFormat](../../../types/store.RawMessageFormat/page.mdx)<T> \\| [RawMessageFormat](../../../types/store.RawMessageFormat/page.mdx)<T>[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"source","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"Pick<[Context](../../../interfaces/store.Context/page.mdx), \"eventGroupId\">","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, any>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="saveRawMessageData"/>
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"alias","type":"[JoinerServiceConfigAlias](../../../interfaces/store.JoinerServiceConfigAlias/page.mdx) \\| [JoinerServiceConfigAlias](../../../interfaces/store.JoinerServiceConfigAlias/page.mdx)[]","description":"Property name to use as entrypoint to the service","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","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":"entity","type":"`string`","description":"","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":"fieldAlias","type":"`Record<string, string \\| object>`","description":"alias for deeper nested relationships (e.g. { 'price': 'prices.calculated\\_price\\_set.amount' })","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"path","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"forwardArgumentsOnPath","type":"`string`[]","description":"","optional":false,"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":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../../types/store.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"`boolean`","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"Force the relationship to return a list","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":"deleteCascade","type":"`boolean`","description":"If true, the link joiner will cascade deleting the relationship","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"relationship","type":"[ModuleJoinerRelationship](../../../types/store.ModuleJoinerRelationship/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"`boolean`","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"chiLine truncated
|
||||
<TypeList types={[{"name":"alias","type":"[JoinerServiceConfigAlias](../../../interfaces/store.JoinerServiceConfigAlias/page.mdx) \\| [JoinerServiceConfigAlias](../../../interfaces/store.JoinerServiceConfigAlias/page.mdx)[]","description":"Property name to use as entrypoint to the service","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","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":"fieldAlias","type":"`Record<string, string \\| object>`","description":"alias for deeper nested relationships (e.g. { 'price': 'prices.calculated\\_price\\_set.amount' })","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"path","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"forwardArgumentsOnPath","type":"`string`[]","description":"","optional":false,"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":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../../types/store.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"`boolean`","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"Force the relationship to return a list","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":"deleteCascade","type":"`boolean`","description":"If true, the link joiner will cascade deleting the relationship","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"relationship","type":"[ModuleJoinerRelationship](../../../types/store.ModuleJoinerRelationship/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"`boolean`","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"Force the relationship to return a list","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":"deleteCascade","type":"`boolean`","description":"If true, the link joiner Line truncated
|
||||
+1
-1
@@ -46,7 +46,7 @@ const [stores, count] = await storeModuleService.listAndCountStores(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)","description":"The filters to apply on the retrieved stores.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/store.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter stores by their associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../..Line truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)","description":"The filters to apply on the retrieved stores.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/store.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter stores by their associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/store.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter stores by their associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"q","type":"`string`","description":"Find stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter storesLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -44,7 +44,7 @@ const stores = await storeModuleService.listStores(
|
||||
|
||||
## Parameters
|
||||
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)","description":"The filters to apply on the retrieved stores.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/store.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter stores by their associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../..Line truncated
|
||||
<TypeList types={[{"name":"filters","type":"[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)","description":"The filters to apply on the retrieved stores.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/store.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter stores by their associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/store.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter stores by their associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"q","type":"`string`","description":"Find stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter storesLine truncated
|
||||
|
||||
## Returns
|
||||
|
||||
|
||||
+1
-1
@@ -54,7 +54,7 @@ const store = await storeModuleService.updateStores(
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)","description":"The filters specifying which stores to update.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/store.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter stores by their associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../..Line truncated
|
||||
<TypeList types={[{"name":"selector","type":"[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)","description":"The filters specifying which stores to update.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/store.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter stores by their associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx) \\| [BaseFilterable](../../../interfaces/store.BaseFilterable/page.mdx)<[FilterableStoreProps](../../../interfaces/store.FilterableStoreProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/store.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter stores by their associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"q","type":"`string`","description":"Find stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stoLine truncated
|
||||
|
||||
### Returns
|
||||
|
||||
|
||||
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
The filters to apply on the retrieved stores.
|
||||
|
||||
<TypeList types={[{"name":"$and","type":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/store.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter stores by their associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../store.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../store.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/store.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter stores by their associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../store.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../store.BaseFilterablLine truncated
|
||||
<TypeList types={[{"name":"$and","type":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/store.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter stores by their associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableStoreProps](./page.mdx) \\| [BaseFilterable](../store.BaseFilterable/page.mdx)<[FilterableStoreProps](./page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/store.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter stores by their associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"q","type":"`string`","description":"Find stores by name through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the stores by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter stores by their names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../types/store.OperatorMap/page.mdx)<string \\| string[]>","description":"Filter stores by their associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../types/store.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":faLine truncated
|
||||
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
# JoinerServiceConfig
|
||||
|
||||
<TypeList types={[{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"alias","type":"[JoinerServiceConfigAlias](../store.JoinerServiceConfigAlias/page.mdx) \\| [JoinerServiceConfigAlias](../store.JoinerServiceConfigAlias/page.mdx)[]","description":"Property name to use as entrypoint to the service","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","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":"entity","type":"`string`","description":"","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":"fieldAlias","type":"`Record<string, string \\| object>`","description":"alias for deeper nested relationships (e.g. { 'price': 'prices.calculated\\_price\\_set.amount' })","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"path","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"forwardArgumentsOnPath","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"relationships","type":"[JoinerRelationship](../../types/store.JoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"`boolean`","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"Force the relationship to return a list","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":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"relationship","type":"[JoinerRelationship](../../types/store.JoinerRelationship/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"`boolean`","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"Force the relationship to return a list","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":"entiLine truncated
|
||||
<TypeList types={[{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"alias","type":"[JoinerServiceConfigAlias](../store.JoinerServiceConfigAlias/page.mdx) \\| [JoinerServiceConfigAlias](../store.JoinerServiceConfigAlias/page.mdx)[]","description":"Property name to use as entrypoint to the service","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","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":"fieldAlias","type":"`Record<string, string \\| object>`","description":"alias for deeper nested relationships (e.g. { 'price': 'prices.calculated\\_price\\_set.amount' })","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"path","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"forwardArgumentsOnPath","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"relationships","type":"[JoinerRelationship](../../types/store.JoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"`boolean`","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"Force the relationship to return a list","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":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"relationship","type":"[JoinerRelationship](../../types/store.JoinerRelationship/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"`boolean`","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"Force the relationship to return a list","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":"entity","type":"`string`","description":"","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":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="JoinerServLine truncated
|
||||
Reference in new issue
Block a user