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

chore(docs): Generated References (#9551)

Browse Source 
Generated the following references:
- `api_key`
- `auth`
- `cart`
- `core_flows`
- `currency`
- `customer`
- `fulfillment`
- `inventory_next`
- `modules`
- `modules_sdk`
- `order`
- `order_models`
- `payment`
- `payment_provider`
- `pricing`
- `product`
- `promotion`
- `region`
- `sales_channel`
- `search`
- `stock_location_next`
- `store`
- `tax`
- `types`
- `user`
- `utils`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andOli Juhl authored and GitHub committed 2024-10-14 10:33:21 +00:00
1 parent 089d4af301
commit 224e530453
393 files changed
+384350 -379636
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/resources/references/helper_steps/functions/helper_steps.useQueryGraphStep/page.mdx
+22
View File
@@ -0,0 +1,22 @@
---
slug: /references/helper-steps/useQueryGraphStep
sidebar_label: useQueryGraphStep
---
import { TypeList } from "docs-ui"
# useQueryGraphStep - Helper Steps API Reference
This documentation provides a reference to the `useQueryGraphStep` step. It belongs to the `@medusajs/medusa/core-flows` package.
## Type Parameters
<TypeList types={[{"name":"TEntry","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="useQueryGraphStep"/>
## Parameters
<TypeList types={[{"name":"input","type":"[EntryStepInput](../../../core_flows/interfaces/core_flows.EntryStepInput/page.mdx)&#60;TEntry&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"The fields to retrieve in the records.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entry_point","type":"`string`","description":"The name of the data model to retrieve its records.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variables","type":"`Record<string, any>`","description":"Filters, context variables, or pagination fields to apply when retrieving the records.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"throw_if_key_not_found","type":"`boolean`","description":"Throw an error if a record isn't found matching an ID specified in the filters.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"throw_if_relation_not_found","type":"`boolean` \\| `string`[]","description":"Throw an error if a specified relation isn't found.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"`boolean`","description":"Whether to retrieve the records as an array. If disabled, only one record is retrieved as an object.","optional":true,"defaultValue":"true","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="useQueryGraphStep"/>
## Returns
<TypeList types={[{"name":"data","type":"TEntry extends `never` ? [RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)[TEntry&#60;TEntry&#62;][] : `any`[] \\| [WorkflowData](../../../workflows/types/workflows.WorkflowData/page.mdx)&#60;TEntry extends never ? [RemoteQueryEntryPoints](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.RemoteQueryEntryPoints/page.mdx)[TEntry&#60;TEntry&#62;][] : any[]&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"GraphResultSet","type":"[GraphResultSet](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.GraphResultSet/page.mdx)&#60;TEntry&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"WorkflowDataProperties","type":"[WorkflowDataProperties](../../../workflows/types/workflows.WorkflowDataProperties/page.mdx)&#60;[GraphResultSet](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.GraphResultSet/page.mdx)&#60;TEntry&#62;&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"config","type":"(`config`: ``{ name?: string }`` & Omit&#60;TransactionStepsDefinition, \"next\" \\| \"uuid\" \\| \"action\"&#62;) => [WorkflowData](../../../workflows/types/workflows.WorkflowData/page.mdx)&#60;[GraphResultSet](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.GraphResultSet/page.mdx)&#60;TEntry&#62;&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"StepFunctionReturnConfig","type":"[StepFunctionReturnConfig](../../../workflows/types/workflows.StepFunctionReturnConfig/page.mdx)&#60;[GraphResultSet](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.GraphResultSet/page.mdx)&#60;TEntry&#62;&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"metadata","type":"[RemoteQueryFunctionReturnPagination](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFunctionReturnPagination/page.mdx) \\| [WorkflowData](../../../workflows/types/workflows.WorkflowData/page.mdx)&#60;undefined \\| [RemoteQueryFunctionReturnPagination](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFunctionReturnPagination/page.mdx)&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="useQueryGraphStep"/>