asyavee/medusa-store
1
0 Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

chore(docs): Generated References (automated) (#12824)

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andolivermrbl authored and GitHub committed 2025-06-25 13:51:49 +03:00
1 parent e698a09be7
commit 2b0c8c6662
932 files changed
+342117 -335859
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/resources/references/modules_sdk/classes/modules_sdk.Query/page.mdx
+4 -4
View File
@@ -14,7 +14,7 @@ ___
## Properties
<TypeList types={[{"name":"instrument","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"traceGraphQuery","type":"(`queryFn`: () => Promise&#60;any&#62;, `queryOptions`: [RemoteQueryInput](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryInput/page.mdx)&#60;any&#62;) => Promise&#60;any&#62;","description":"Method to wrap execution of the graph query for instrumentation","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"traceRemoteQuery","type":"(`queryFn`: () => Promise&#60;any&#62;, `queryOptions`: [RemoteJoinerQuery](../../../types/interfaces/types.RemoteJoinerQuery/page.mdx) \\| [RemoteQueryObjectConfig](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryObjectConfig/page.mdx)&#60;any&#62; \\| [RemoteQueryObjectFromStringResult](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryObjectFromStringResult/page.mdx)&#60;any&#62;) => Promise&#60;any&#62;","description":"Method to wrap execution of the remoteQuery overload function\nfor instrumentation","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Query"/>
<TypeList types={[{"name":"instrument","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"traceGraphQuery","type":"(`queryFn`: () => Promise&#60;any&#62;, `queryOptions`: ``{ entity: any ; fields: string[] ; pagination?: &#123; skip?: number ; take?: number ; order?: Record&#60;string, any&#62; \\| &#123;&#125; &#125; ; filters?: [RemoteQueryFilters](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFilters/page.mdx)&#60;any&#62; ; context?: [QueryContextType](../../../types/CommonTypes/types/types.CommonTypes.QueryContextType/page.mdx) ; withDeleted?: boolean ; strategy?: \"joined\" \\| \"select-in\" }`` \\| ``{ entity: any ; fields: string[] ; pagination?: &#123; skip?: number ; take?: number ; order?: Record&#60;string, any&#62; \\| &#123;&#125; &#125; ; filters?: [RemoteQueryFilters](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFilters/page.mdx)&#60;any&#62; ; context?: [QueryContextType](../../../types/CommonTypes/types/types.CommonTypes.QueryContextType/page.mdx) ; withDeleted?: boolean ; strategy?: \"joined\" \\| \"select-in\" }``) => Promise&#60;any&#62;","description":"Method to wrap execution of the graph query for instrumentation","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"traceRemoteQuery","type":"(`queryFn`: () => Promise&#60;any&#62;, `queryOptions`: [RemoteJoinerQuery](../../../types/interfaces/types.RemoteJoinerQuery/page.mdx) \\| [RemoteQueryObjectConfig](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryObjectConfig/page.mdx)&#60;any&#62; \\| [RemoteQueryObjectFromStringResult](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryObjectFromStringResult/page.mdx)&#60;any&#62;) => Promise&#60;any&#62;","description":"Method to wrap execution of the remoteQuery overload function\nfor instrumentation","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Query"/>
___
@@ -24,7 +24,7 @@ ___
#### Parameters
<TypeList types={[{"name":"queryOptions","type":"[RemoteJoinerQuery](../../../types/interfaces/types.RemoteJoinerQuery/page.mdx) \\| [RemoteQueryInput](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryInput/page.mdx)&#60;any&#62; \\| [RemoteQueryObjectConfig](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryObjectConfig/page.mdx)&#60;any&#62; \\| [RemoteQueryObjectFromStringResult](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryObjectFromStringResult/page.mdx)&#60;any&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"TEntry \\| keyof [RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)","description":"The name of the entity to retrieve. For example, `product`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entryPoint","type":"TEntry \\| keyof [RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__TConfig","type":"TConfig","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__value","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"alias","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"expands","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"property","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"[JoinerArgument](../../../types/interfaces/types.JoinerArgument/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"directives","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"args","type":"[JoinerArgument](../../../types/interfaces/types.JoinerArgument/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"directives","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pagination","type":"`object`","description":"Pagination configurations for the returned list of items.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"skip","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"The maximum number of items to return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[IndexOrderBy](../../../types/IndexTypes/types/types.IndexTypes.IndexOrderBy/page.mdx)&#60;TEntry&#62;","description":"Sort by field names in ascending or descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"filters","type":"[RemoteQueryFilters](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFilters/page.mdx)&#60;TEntry&#62;","description":"Filters to apply on the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[QueryContextType](../../../types/CommonTypes/types/types.CommonTypes.QueryContextType/page.mdx)","description":"Apply a query context on the retrieved data. For example, to retrieve product prices for a certain context.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"Apply a `withDeleted` flag on the retrieved data to retrieve soft deleted items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"strategy","type":"`\"joined\"` \\| `\"select-in\"`","description":"Strategy will be send to the entry module called method","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variables","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[RemoteJoinerOptions](../../../types/interfaceLine truncated
<TypeList types={[{"name":"queryOptions","type":"[RemoteJoinerQuery](../../../types/interfaces/types.RemoteJoinerQuery/page.mdx) \\| `object` \\| `object` \\| [RemoteQueryObjectConfig](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryObjectConfig/page.mdx)&#60;any&#62; \\| [RemoteQueryObjectFromStringResult](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryObjectFromStringResult/page.mdx)&#60;any&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`any`","description":"The name of the entity to retrieve. For example, `product`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entryPoint","type":"TEntry \\| keyof [RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__TConfig","type":"TConfig","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__value","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"alias","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"expands","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"property","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"[JoinerArgument](../../../types/interfaces/types.JoinerArgument/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"directives","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"args","type":"[JoinerArgument](../../../types/interfaces/types.JoinerArgument/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"directives","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pagination","type":"`object`","description":"Pagination configurations for the returned list of items.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"skip","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"The maximum number of items to return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`Record<string, any>` \\| `object`","description":"Sort by field names in ascending or descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"filters","type":"[RemoteQueryFilters](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFilters/page.mdx)&#60;any&#62;","description":"Filters to apply on the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$or","type":"T & [RemoteQueryFilterOperators](../../../types/types/types.RemoteQueryFilterOperators/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"T & [RemoteQueryFilterOperators](../../../types/types/types.RemoteQueryFilterOperators/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"T & [RemoteQueryFilterOperators](../../../types/types/types.RemoteQueryFilterOperators/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"context","type":"[QueryContextType](../../../types/CommonTypes/types/types.CommonTypes.QueryContextType/page.mdx)","description":"Apply a query context on the retrieved data. For example, to retrieve product prices for a certain context.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"Apply a `withDeleted` flag on the retrieved data to retrieve soft deleted items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"strategy","type":"`\"joined\"` \\Line truncated
#### Returns
@@ -53,7 +53,7 @@ returns a result set
#### Parameters
<TypeList types={[{"name":"queryOptions","type":"[RemoteQueryInput](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryInput/page.mdx)&#60;TEntry&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"entity","type":"TEntry \\| keyof [RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)","description":"The name of the entity to retrieve. For example, `product`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"[ObjectToRemoteQueryFields](../../../types/types/types.ObjectToRemoteQueryFields/page.mdx)&#60;[RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)[TEntry & keyof [RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)]&#62; extends `never` ? `string`[] : [ObjectToRemoteQueryFields](../../../types/types/types.ObjectToRemoteQueryFields/page.mdx)&#60;[RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)[TEntry & keyof [RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)]&#62;[] \\| `string`[]","description":"The fields and relations to retrieve in the entity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pagination","type":"`object`","description":"Pagination configurations for the returned list of items.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"skip","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"The maximum number of items to return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[IndexOrderBy](../../../types/IndexTypes/types/types.IndexTypes.IndexOrderBy/page.mdx)&#60;TEntry&#62;","description":"Sort by field names in ascending or descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"filters","type":"[RemoteQueryFilters](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFilters/page.mdx)&#60;TEntry&#62;","description":"Filters to apply on the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[QueryContextType](../../../types/CommonTypes/types/types.CommonTypes.QueryContextType/page.mdx)","description":"Apply a query context on the retrieved data. For example, to retrieve product prices for a certain context.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"Apply a `withDeleted` flag on the retrieved data to retrieve soft deleted items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"strategy","type":"`\"joined\"` \\| `\"select-in\"`","description":"Strategy will be send to the entry module called method","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[RemoteJoinerOptions](../../../types/interfaces/types.RemoteJoinerOptions/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"throwIfKeyNotFound","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"throwIfRelationNotFound","type":"`boolean` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"initialData","type":"`object` \\| `object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"initialDataOnly","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="graph"/>
<TypeList types={[{"name":"queryOptions","type":"[RemoteQueryInput](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryInput/page.mdx)&#60;TEntry&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[RemoteJoinerOptions](../../../types/interfaces/types.RemoteJoinerOptions/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"throwIfKeyNotFound","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"throwIfRelationNotFound","type":"`boolean` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"initialData","type":"`object` \\| `object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"initialDataOnly","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="graph"/>
#### Returns
@@ -70,7 +70,7 @@ returns a result set
#### Parameters
<TypeList types={[{"name":"queryOptions","type":"[RemoteQueryInput](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryInput/page.mdx)&#60;TEntry&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"entity","type":"TEntry \\| keyof [RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)","description":"The name of the entity to retrieve. For example, `product`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"[ObjectToRemoteQueryFields](../../../types/types/types.ObjectToRemoteQueryFields/page.mdx)&#60;[RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)[TEntry & keyof [RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)]&#62; extends `never` ? `string`[] : [ObjectToRemoteQueryFields](../../../types/types/types.ObjectToRemoteQueryFields/page.mdx)&#60;[RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)[TEntry & keyof [RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)]&#62;[] \\| `string`[]","description":"The fields and relations to retrieve in the entity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pagination","type":"`object`","description":"Pagination configurations for the returned list of items.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"skip","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"The maximum number of items to return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[IndexOrderBy](../../../types/IndexTypes/types/types.IndexTypes.IndexOrderBy/page.mdx)&#60;TEntry&#62;","description":"Sort by field names in ascending or descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"filters","type":"[RemoteQueryFilters](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFilters/page.mdx)&#60;TEntry&#62;","description":"Filters to apply on the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[QueryContextType](../../../types/CommonTypes/types/types.CommonTypes.QueryContextType/page.mdx)","description":"Apply a query context on the retrieved data. For example, to retrieve product prices for a certain context.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"Apply a `withDeleted` flag on the retrieved data to retrieve soft deleted items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"strategy","type":"`\"joined\"` \\| `\"select-in\"`","description":"Strategy will be send to the entry module called method","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"joinFilters","type":"TEntry extends keyof [RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx) ? Required&#60;Exclude&#60;[RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)[TEntry&#60;TEntry&#62;], undefined \\| null&#62;&#62; extends `V`[] ? &#123; [K in string \\| number \\| symbol]: OmitNever&#60;ExtractFiltersOperators&#60;V, 2, [TEntry&#60;(...)&#62;], Required&#60;Exclude&#60;(...), (...)&#62;&#62;&#62;&#62;[K] &#125; : &#123; [K in string \\| number \\| symbol]: OmitNever&#60;ExtractFiltersOperators&#60;RemoteQueryEntryPoints[TEntry&#60;(...)&#62;], 2, [TEntry&#60;(...)&#62;], Required&#60;Exclude&#60;(...), (...)&#62;&#62;&#62;&#62;[K] &#125; : `Record<string, any>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"[RemoteJoinerOptions](../../../types/interfaces/types.RemoteJoinerOptions/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"throwIfKeyNotFound","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"throwIfRelationNotFound","type":"`boolean` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"initialData","type":"`object` \\| `object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"initialDataOnly","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.coLine truncated
<TypeList types={[{"name":"queryOptions","type":"[RemoteQueryInput](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryInput/page.mdx)&#60;TEntry&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"joinFilters","type":"[RemoteQueryFilters](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFilters/page.mdx)&#60;TEntry&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$or","type":"T & [RemoteQueryFilterOperators](../../../types/types/types.RemoteQueryFilterOperators/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"T & [RemoteQueryFilterOperators](../../../types/types/types.RemoteQueryFilterOperators/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"T & [RemoteQueryFilterOperators](../../../types/types/types.RemoteQueryFilterOperators/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"options","type":"[RemoteJoinerOptions](../../../types/interfaces/types.RemoteJoinerOptions/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"throwIfKeyNotFound","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"throwIfRelationNotFound","type":"`boolean` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"initialData","type":"`object` \\| `object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"initialDataOnly","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="index"/>
#### Returns