chore(docs): Generated References (automated) (#9419)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
This commit is contained in:
1 parent
e73e95f5e9
commit
34eebb61eb
585 files changed
+1248
-984
No files matched your search
+3
-3
@@ -7,14 +7,14 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
# createRemoteLinkStep - Helper Steps API Reference
|
||||
|
||||
This documentation provides a reference to the `createRemoteLinkStep` step. It belongs to the `@medusajs/core-flows` package.
|
||||
This documentation provides a reference to the `createRemoteLinkStep` step. It belongs to the `@medusajs/medusa/core-flows` package.
|
||||
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import { createWorkflow } from "@medusajs/framework/workflows-sdk"
|
||||
import { createWorkflow } from "@medusajs/workflows-sdk"
|
||||
import { createRemoteLinkStep } from "@medusajs/core-flows"
|
||||
import { Modules } from "@medusajs/framework/utils"
|
||||
import { Modules } from "@medusajs/utils"
|
||||
|
||||
const helloWorldWorkflow = createWorkflow("hello-world", () => {
|
||||
createRemoteLinkStep([
|
||||
|
||||
+3
-3
@@ -7,20 +7,20 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
# dismissRemoteLinkStep - Helper Steps API Reference
|
||||
|
||||
This documentation provides a reference to the `dismissRemoteLinkStep` step. It belongs to the `@medusajs/core-flows` package.
|
||||
This documentation provides a reference to the `dismissRemoteLinkStep` step. It belongs to the `@medusajs/medusa/core-flows` package.
|
||||
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
createWorkflow
|
||||
} from "@medusajs/framework/workflows-sdk"
|
||||
} from "@medusajs/workflows-sdk"
|
||||
import {
|
||||
dismissRemoteLinkStep
|
||||
} from "@medusajs/core-flows"
|
||||
import {
|
||||
Modules
|
||||
} from "@medusajs/framework/utils"
|
||||
} from "@medusajs/utils"
|
||||
|
||||
const helloWorldWorkflow = createWorkflow(
|
||||
"hello-world",
|
||||
|
||||
+2
-2
@@ -7,14 +7,14 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
# emitEventStep - Helper Steps API Reference
|
||||
|
||||
This documentation provides a reference to the `emitEventStep` step. It belongs to the `@medusajs/core-flows` package.
|
||||
This documentation provides a reference to the `emitEventStep` step. It belongs to the `@medusajs/medusa/core-flows` package.
|
||||
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
createWorkflow
|
||||
} from "@medusajs/framework/workflows-sdk"
|
||||
} from "@medusajs/workflows-sdk"
|
||||
import {
|
||||
emitEventStep
|
||||
} from "@medusajs/core-flows"
|
||||
|
||||
+3
-3
@@ -7,20 +7,20 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
# removeRemoteLinkStep - Helper Steps API Reference
|
||||
|
||||
This documentation provides a reference to the `removeRemoteLinkStep` step. It belongs to the `@medusajs/core-flows` package.
|
||||
This documentation provides a reference to the `removeRemoteLinkStep` step. It belongs to the `@medusajs/medusa/core-flows` package.
|
||||
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import {
|
||||
createWorkflow
|
||||
} from "@medusajs/framework/workflows-sdk"
|
||||
} from "@medusajs/workflows-sdk"
|
||||
import {
|
||||
removeRemoteLinkStep
|
||||
} from "@medusajs/core-flows"
|
||||
import {
|
||||
Modules
|
||||
} from "@medusajs/framework/utils"
|
||||
} from "@medusajs/utils"
|
||||
|
||||
const helloWorldWorkflow = createWorkflow(
|
||||
"hello-world",
|
||||
|
||||
+1
-1
@@ -7,7 +7,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
# updateRemoteLinksStep - Helper Steps API Reference
|
||||
|
||||
This documentation provides a reference to the `updateRemoteLinksStep` step. It belongs to the `@medusajs/core-flows` package.
|
||||
This documentation provides a reference to the `updateRemoteLinksStep` step. It belongs to the `@medusajs/medusa/core-flows` package.
|
||||
|
||||
## Input
|
||||
|
||||
|
||||
+4
-4
@@ -7,7 +7,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
# useRemoteQueryStep - Helper Steps API Reference
|
||||
|
||||
This documentation provides a reference to the `useRemoteQueryStep` step. It belongs to the `@medusajs/core-flows` package.
|
||||
This documentation provides a reference to the `useRemoteQueryStep` step. It belongs to the `@medusajs/medusa/core-flows` package.
|
||||
|
||||
## Example
|
||||
|
||||
@@ -16,7 +16,7 @@ To retrieve a list of records of a data model:
|
||||
```ts
|
||||
import {
|
||||
createWorkflow
|
||||
} from "@medusajs/framework/workflows-sdk"
|
||||
} from "@medusajs/workflows-sdk"
|
||||
import {
|
||||
useRemoteQueryStep
|
||||
} from "@medusajs/core-flows"
|
||||
@@ -40,7 +40,7 @@ To retrieve a single item instead of a an array:
|
||||
```ts
|
||||
import {
|
||||
createWorkflow
|
||||
} from "@medusajs/framework/workflows-sdk"
|
||||
} from "@medusajs/workflows-sdk"
|
||||
import {
|
||||
useRemoteQueryStep
|
||||
} from "@medusajs/core-flows"
|
||||
@@ -70,7 +70,7 @@ To throw an error if a record isn't found matching the specified ID:
|
||||
```ts
|
||||
import {
|
||||
createWorkflow
|
||||
} from "@medusajs/framework/workflows-sdk"
|
||||
} from "@medusajs/workflows-sdk"
|
||||
import {
|
||||
useRemoteQueryStep
|
||||
} from "@medusajs/core-flows"
|
||||
|
||||
Reference in new issue
Block a user