Skip to content

Commit 5d39775

Browse files
committed
Rename metadata.update() to metadata.save()
1 parent 493a30c commit 5d39775

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

docs/runs/metadata.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ export const myTask = task({
7171
});
7272
```
7373

74-
You can update metadata inside a run using `metadata.set()`, `metadata.update()`, or `metadata.del()`:
74+
You can update metadata inside a run using `metadata.set()`, `metadata.save()`, or `metadata.del()`:
7575

7676
```ts
7777
import { task, metadata } from "@trigger.dev/sdk/v3";
@@ -83,7 +83,7 @@ export const myTask = task({
8383
await metadata.set("progress", 0.5);
8484

8585
// Update the entire metadata object
86-
await metadata.update({ progress: 0.6 });
86+
await metadata.save({ progress: 0.6 });
8787

8888
// Delete a key
8989
await metadata.del("progress");

packages/trigger-sdk/src/v3/metadata.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ import { tracer } from "./tracer.js";
1515
* @property {Function} get - Get a specific key from the current run's metadata.
1616
* @property {Function} set - Set a key in the current run's metadata.
1717
* @property {Function} del - Delete a key from the current run's metadata.
18-
* @property {Function} update - Update the entire metadata object for the current run.
18+
* @property {Function} save - Update the entire metadata object for the current run.
1919
*/
2020

2121
export const metadata = {
2222
current: currentMetadata,
2323
get: getMetadataKey,
2424
set: setMetadataKey,
2525
del: deleteMetadataKey,
26-
update: updateMetadata,
26+
save: saveMetadata,
2727
};
2828

2929
export type RunMetadata = Record<string, DeserializedJson>;
@@ -142,16 +142,16 @@ async function deleteMetadataKey(key: string, requestOptions?: ApiRequestOptions
142142
* @returns {Promise<void>} A promise that resolves when the metadata is updated.
143143
*
144144
* @example
145-
* await metadata.update({ progress: 0.6, user: { name: "Alice", id: "user_5678" } });
145+
* await metadata.save({ progress: 0.6, user: { name: "Alice", id: "user_5678" } });
146146
*/
147-
async function updateMetadata(
147+
async function saveMetadata(
148148
metadata: RunMetadata,
149149
requestOptions?: ApiRequestOptions
150150
): Promise<void> {
151151
const $requestOptions = mergeRequestOptions(
152152
{
153153
tracer,
154-
name: "metadata.update()",
154+
name: "metadata.save()",
155155
icon: "code-plus",
156156
attributes: {
157157
...flattenAttributes(metadata),

references/v3-catalog/src/trigger/runMetadata.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export const runMetadataChildTask = task({
3131

3232
logger.info("metadata", { metadata: metadata.current() });
3333

34-
await metadata.update({
34+
await metadata.save({
3535
there: {
3636
is: {
3737
something: "here",

0 commit comments

Comments
 (0)