Skip to content

Commit 0747f4d

Browse files
committed
docs: various improvements and fixes
1 parent 75eac9e commit 0747f4d

File tree

25 files changed

+88026
-77705
lines changed

25 files changed

+88026
-77705
lines changed

www/apps/book/app/learn/fundamentals/module-links/custom-columns/page.mdx

Lines changed: 97 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import { CodeTab, CodeTabs } from "docs-ui"
2+
13
export const metadata = {
24
title: `${pageNumber} Add Columns to a Link Table`,
35
}
@@ -97,10 +99,13 @@ For example:
9799

98100
<Note>
99101

100-
Learn more about Link, how to resolve it, and its methods in [this chapter](../link/page.mdx).
102+
Refer to the [Link](../link/page.mdx) chapter to learn how to import and use the `link` instance.
101103

102104
</Note>
103105

106+
<CodeTabs group="link">
107+
<CodeTab label="Link" value="link">
108+
104109
```ts
105110
await link.create({
106111
[Modules.PRODUCT]: {
@@ -117,6 +122,50 @@ await link.create({
117122
})
118123
```
119124

125+
</CodeTab>
126+
<CodeTab label="createRemoteLinksStep" value="createRemoteLinksStep">
127+
128+
```ts
129+
import { Modules } from "@medusajs/framework/utils"
130+
import { BLOG_MODULE } from "../modules/blog"
131+
import { createRemoteLinksStep } from "@medusajs/medusa/core-flows"
132+
import {
133+
createWorkflow,
134+
transform,
135+
} from "@medusajs/framework/workflows-sdk"
136+
137+
export const myWorkflow = createWorkflow(
138+
"my-workflow",
139+
() => {
140+
// ...
141+
const linkData = transform({
142+
// TODO pass input data
143+
}, () => {
144+
return [
145+
{
146+
[Modules.PRODUCT]: {
147+
product_id: "123",
148+
},
149+
[BLOG_MODULE]: {
150+
post_id: "321",
151+
},
152+
data: {
153+
metadata: {
154+
test: true,
155+
},
156+
},
157+
},
158+
]
159+
})
160+
createRemoteLinksStep(linkData)
161+
// ...
162+
}
163+
)
164+
```
165+
166+
</CodeTab>
167+
</CodeTabs>
168+
120169
---
121170

122171
## Retrieve Custom Column with Link
@@ -189,6 +238,9 @@ So, to update the value of a custom column in a created link, use the `create` m
189238

190239
For example:
191240

241+
<CodeTabs group="link">
242+
<CodeTab label="Link" value="link">
243+
192244
```ts
193245
await link.create({
194246
[Modules.PRODUCT]: {
@@ -204,3 +256,47 @@ await link.create({
204256
},
205257
})
206258
```
259+
260+
</CodeTab>
261+
<CodeTab label="updateRemoteLinksStep" value="updateRemoteLinksStep">
262+
263+
```ts
264+
import { Modules } from "@medusajs/framework/utils"
265+
import { BLOG_MODULE } from "../modules/blog"
266+
import { updateRemoteLinksStep } from "@medusajs/medusa/core-flows"
267+
import {
268+
createWorkflow,
269+
transform,
270+
} from "@medusajs/framework/workflows-sdk"
271+
272+
export const myWorkflow = createWorkflow(
273+
"my-workflow",
274+
() => {
275+
// ...
276+
const linkData = transform({
277+
// TODO pass input data
278+
}, () => {
279+
return [
280+
{
281+
[Modules.PRODUCT]: {
282+
product_id: "123",
283+
},
284+
[BLOG_MODULE]: {
285+
post_id: "321",
286+
},
287+
data: {
288+
metadata: {
289+
test: false,
290+
},
291+
},
292+
},
293+
]
294+
})
295+
updateRemoteLinksStep(linkData)
296+
// ...
297+
}
298+
)
299+
```
300+
301+
</CodeTab>
302+
</CodeTabs>

0 commit comments

Comments
 (0)