chore(docs): Generated References (automated) (#11579)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
759 files changed
+428283
-416492
No files matched your search
@@ -8,7 +8,7 @@ API wrapper around the remoteQuery
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"remoteQuery","type":"[RemoteQuery](../modules_sdk.RemoteQuery/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"traceFetchRemoteData","type":"(`fetcher`: () => Promise<any>, `serviceName`: `string`, `method`: `string`, `options`: ``{ select?: string[] ; relations: string[] }``) => Promise<any>","description":"","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":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"remoteQuery","type":"[RemoteQuery](../modules_sdk.RemoteQuery/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"traceFetchRemoteData","type":"(`fetcher`: () => Promise<any>, `serviceName`: `string`, `method`: `string`, `options`: ``{ select?: string[] ; relations: string[] }``) => Promise<any>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"indexModule","type":"[IIndexService](../../../types/IndexTypes/interfaces/types.IndexTypes.IIndexService/page.mdx)","description":"","optional":false,"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)<any> \\| [RemoteQueryObjectConfig](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryObjectConfig/page.mdx)<any> \\| [RemoteQueryObjectFromStringResult](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryObjectFromStringResult/page.mdx)<any>","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)<TEntry>","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)<TEntry>","description":"Filters to apply on the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`any`","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":"variables","type":"`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,"deLine truncated
|
||||
<TypeList types={[{"name":"queryOptions","type":"[RemoteJoinerQuery](../../../types/interfaces/types.RemoteJoinerQuery/page.mdx) \\| [RemoteQueryInput](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryInput/page.mdx)<any> \\| [RemoteQueryObjectConfig](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryObjectConfig/page.mdx)<any> \\| [RemoteQueryObjectFromStringResult](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryObjectFromStringResult/page.mdx)<any>","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)<TEntry>","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)<TEntry>","description":"Filters to apply on the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`any`","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":"variables","type":"`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","typLine truncated
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -53,8 +53,25 @@ returns a result set
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"queryOptions","type":"[RemoteQueryInput](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryInput/page.mdx)<TEntry>","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)<[RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)[TEntry & keyof [RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)]> extends `never` ? `string`[] : [ObjectToRemoteQueryFields](../../../types/types/types.ObjectToRemoteQueryFields/page.mdx)<[RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)[TEntry & keyof [RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)]>[] \\| `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)<TEntry>","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)<TEntry>","description":"Filters to apply on the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`any`","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":"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":[]}]}]} 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)<TEntry>","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)<[RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)[TEntry & keyof [RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)]> extends `never` ? `string`[] : [ObjectToRemoteQueryFields](../../../types/types/types.ObjectToRemoteQueryFields/page.mdx)<[RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)[TEntry & keyof [RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)]>[] \\| `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)<TEntry>","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)<TEntry>","description":"Filters to apply on the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`any`","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":"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":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="graph"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[GraphResultSet](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.GraphResultSet/page.mdx)<TEntry>>","optional":false,"defaultValue":"","description":"Graph function uses the remoteQuery under the hood and\nreturns a result set","expandable":false,"children":[{"name":"GraphResultSet","type":"[GraphResultSet](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.GraphResultSet/page.mdx)<TEntry>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TEntry","type":"TEntry","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="graph"/>
|
||||
|
||||
### index
|
||||
|
||||
Index function uses the Index module to query and hydrates the data with query.graph
|
||||
returns a result set
|
||||
|
||||
#### Type Parameters
|
||||
|
||||
<TypeList types={[{"name":"TEntry","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="index"/>
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"queryOptions","type":"[RemoteQueryInput](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryInput/page.mdx)<TEntry> & `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)<[RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)[TEntry & keyof [RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)]> extends `never` ? `string`[] : [ObjectToRemoteQueryFields](../../../types/types/types.ObjectToRemoteQueryFields/page.mdx)<[RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)[TEntry & keyof [RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)]>[] \\| `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)<TEntry>","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)<TEntry>","description":"Filters to apply on the retrieved items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`any`","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":"joinFilters","type":"TEntry extends keyof [RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx) ? Required<Exclude<[RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)[TEntry<TEntry>], undefined \\| null>> extends `V`[] ? { [K in string \\| number \\| symbol]: OmitNever<ExtractFiltersOperators<V, 2, [TEntry<(...)>], Required<Exclude<(...), (...)>>>>[K] } : { [K in string \\| number \\| symbol]: OmitNever<ExtractFiltersOperators<RemoteQueryEntryPoints[TEntry<(...)>], 2, [TEntry<(...)>], Required<Exclude<(...), (...)>>>>[K] } : `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":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="index"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[GraphResultSet](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.GraphResultSet/page.mdx)<TEntry>>","optional":false,"defaultValue":"","description":"Index function uses the Index module to query and hydrates the data with query.graph\nreturns a result set","expandable":false,"children":[{"name":"GraphResultSet","type":"[GraphResultSet](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.GraphResultSet/page.mdx)<TEntry>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TEntry","type":"TEntry","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="index"/>
|
||||
@@ -34,7 +34,7 @@ ___
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"expand","type":"[RemoteExpandProperty](../../../types/interfaces/types.RemoteExpandProperty/page.mdx) \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"property","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceConfig","type":"[InternalJoinerServiceConfig](../../../types/types/types.InternalJoinerServiceConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"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](../../../types/interfaces/types.JoinerServiceConfigAlias/page.mdx) \\| [JoinerServiceConfigAlias](../../../types/interfaces/types.JoinerServiceConfigAlias/page.mdx)[]","description":"Property name to use as entrypoint to the service","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":"extends","type":"`object`[]","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":"relationships","type":"Map<string, [JoinerRelationship](../../../types/types/types.JoinerRelationship/page.mdx) \\| [JoinerRelationship](../../../types/types/types.JoinerRelationship/page.mdx)[]>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parentConfig","type":"[InternalJoinerServiceConfig](../../../types/types/types.InternalJoinerServiceConfig/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"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](../../../types/interfaces/types.JoinerServiceConfigAlias/page.mdx) \\| [JoinerServiceConfigAlias](../../../types/interfaces/types.JoinerServiceConfigAlias/page.mdx)[]","description":"Property name to use as entrypoint to the service","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":"extends","type":"`object`[]","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":"relationships","type":"Map<string, [JoinerRelationship](../../../types/types/types.JoinerRelationship/page.mdx) \\| [JoinerRelationship](../../../types/types/types.JoinerRelationship/page.mdx)[]>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`[]","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":"expands","type":"[RemoteNestedExpands](../../../types/interfaces/types.RemoteNestedExpands/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"prefix","type":"`string`","description":"","optioLine truncated
|
||||
<TypeList types={[{"name":"expand","type":"[RemoteExpandProperty](../../../types/interfaces/types.RemoteExpandProperty/page.mdx) \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"property","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceConfig","type":"[InternalJoinerServiceConfig](../../../types/types/types.InternalJoinerServiceConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"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](../../../types/interfaces/types.JoinerServiceConfigAlias/page.mdx) \\| [JoinerServiceConfigAlias](../../../types/interfaces/types.JoinerServiceConfigAlias/page.mdx)[]","description":"Property name to use as entrypoint to the service","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":"extends","type":"`object`[]","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":"relationships","type":"Map<string, [JoinerRelationship](../../../types/types/types.JoinerRelationship/page.mdx) \\| [JoinerRelationship](../../../types/types/types.JoinerRelationship/page.mdx)[]>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parentConfig","type":"[InternalJoinerServiceConfig](../../../types/types/types.InternalJoinerServiceConfig/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"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](../../../types/interfaces/types.JoinerServiceConfigAlias/page.mdx) \\| [JoinerServiceConfigAlias](../../../types/interfaces/types.JoinerServiceConfigAlias/page.mdx)[]","description":"Property name to use as entrypoint to the service","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":"extends","type":"`object`[]","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":"relationships","type":"Map<string, [JoinerRelationship](../../../types/types/types.JoinerRelationship/page.mdx) \\| [JoinerRelationship](../../../types/types/types.JoinerRelationship/page.mdx)[]>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`[]","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":"expands","type":"[RemoteNestedExpands](../../../types/interfaces/types.RemoteNestedExpands/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"prefix","type":"`string`","description":"","optioLine truncated
|
||||
|
||||
#### Returns
|
||||
|
||||
|
||||
+1
-1
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"modules","type":"`Record<string, [LoadedModule](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx) \\| [LoadedModule](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"link","type":"[Link](../../classes/modules_sdk.Link/page.mdx) \\| `undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[RemoteQueryFunction](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFunction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"graph","type":"[QueryGraphFunction](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.QueryGraphFunction/page.mdx)","description":"Graph function uses the remoteQuery under the hood and\nreturns a result set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gql","type":"(`query`: `string`, `variables?`: `Record<string, unknown>`, `options?`: [RemoteJoinerOptions](../../../types/interfaces/types.RemoteJoinerOptions/page.mdx)) => Promise<any>","description":"Query wrapper to provide specific GraphQL like API around remoteQuery.query","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"runMigrations","type":"[RunMigrationFn](../modules_sdk.RunMigrationFn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revertMigrations","type":"[RevertMigrationFn](../modules_sdk.RevertMigrationFn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"generateMigrations","type":"[GenerateMigrations](../modules_sdk.GenerateMigrations/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"linkMigrationExecutionPlanner","type":"[GetLinkExecutionPlanner](../modules_sdk.GetLinkExecutionPlanner/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationShutdown","type":"() => Promise<void>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationPrepareShutdown","type":"() => Promise<void>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationStart","type":"() => Promise<void>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entitiesMap","type":"`Record<string, any>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gqlSchema","type":"`GraphQLUtils.GraphQLSchema`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"notFound","type":"`Record<string, Record<string, string>>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="MedusaAppOutput"/>
|
||||
<TypeList types={[{"name":"modules","type":"`Record<string, [LoadedModule](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx) \\| [LoadedModule](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"link","type":"[Link](../../classes/modules_sdk.Link/page.mdx) \\| `undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[RemoteQueryFunction](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFunction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"graph","type":"[QueryGraphFunction](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.QueryGraphFunction/page.mdx)","description":"Graph function uses the remoteQuery under the hood and\nreturns a result set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"index","type":"[QueryIndexFunction](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.QueryIndexFunction/page.mdx)","description":"Index function uses the index module to query and remoteQuery to hydrate the data\nreturns a result set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gql","type":"(`query`: `string`, `variables?`: `Record<string, unknown>`, `options?`: [RemoteJoinerOptions](../../../types/interfaces/types.RemoteJoinerOptions/page.mdx)) => Promise<any>","description":"Query wrapper to provide specific GraphQL like API around remoteQuery.query","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"runMigrations","type":"[RunMigrationFn](../modules_sdk.RunMigrationFn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revertMigrations","type":"[RevertMigrationFn](../modules_sdk.RevertMigrationFn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"generateMigrations","type":"[GenerateMigrations](../modules_sdk.GenerateMigrations/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"linkMigrationExecutionPlanner","type":"[GetLinkExecutionPlanner](../modules_sdk.GetLinkExecutionPlanner/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationShutdown","type":"() => Promise<void>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationPrepareShutdown","type":"() => Promise<void>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationStart","type":"() => Promise<void>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entitiesMap","type":"`Record<string, any>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gqlSchema","type":"`GraphQLUtils.GraphQLSchema`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"notFound","type":"`Record<string, Record<string, string>>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="MedusaAppOutput"/>
|
||||
Reference in new issue
Block a user