Rename metadata.update() to metadata.save()

ericallam · ericallam · commit 5d39775028e2 · 2024-09-26T09:22:31.000+01:00
diff --git a/docs/runs/metadata.mdx b/docs/runs/metadata.mdx
@@ -71,7 +71,7 @@ export const myTask = task({
 });
 ```
 
-You can update metadata inside a run using `metadata.set()`, `metadata.update()`, or `metadata.del()`:
+You can update metadata inside a run using `metadata.set()`, `metadata.save()`, or `metadata.del()`:
 
 ```ts
 import { task, metadata } from "@trigger.dev/sdk/v3";
@@ -83,7 +83,7 @@ export const myTask = task({
     await metadata.set("progress", 0.5);
 
     // Update the entire metadata object
-    await metadata.update({ progress: 0.6 });
+    await metadata.save({ progress: 0.6 });
 
     // Delete a key
     await metadata.del("progress");
diff --git a/packages/trigger-sdk/src/v3/metadata.ts b/packages/trigger-sdk/src/v3/metadata.ts
@@ -15,15 +15,15 @@ import { tracer } from "./tracer.js";
  * @property {Function} get - Get a specific key from the current run's metadata.
  * @property {Function} set - Set a key in the current run's metadata.
  * @property {Function} del - Delete a key from the current run's metadata.
- * @property {Function} update - Update the entire metadata object for the current run.
+ * @property {Function} save - Update the entire metadata object for the current run.
  */
 
 export const metadata = {
   current: currentMetadata,
   get: getMetadataKey,
   set: setMetadataKey,
   del: deleteMetadataKey,
-  update: updateMetadata,
+  save: saveMetadata,
 };
 
 export type RunMetadata = Record<string, DeserializedJson>;
@@ -142,16 +142,16 @@ async function deleteMetadataKey(key: string, requestOptions?: ApiRequestOptions
  * @returns {Promise<void>} A promise that resolves when the metadata is updated.
  *
  * @example
- * await metadata.update({ progress: 0.6, user: { name: "Alice", id: "user_5678" } });
+ * await metadata.save({ progress: 0.6, user: { name: "Alice", id: "user_5678" } });
  */
-async function updateMetadata(
+async function saveMetadata(
   metadata: RunMetadata,
   requestOptions?: ApiRequestOptions
 ): Promise<void> {
   const $requestOptions = mergeRequestOptions(
     {
       tracer,
-      name: "metadata.update()",
+      name: "metadata.save()",
       icon: "code-plus",
       attributes: {
         ...flattenAttributes(metadata),
diff --git a/references/v3-catalog/src/trigger/runMetadata.ts b/references/v3-catalog/src/trigger/runMetadata.ts
@@ -31,7 +31,7 @@ export const runMetadataChildTask = task({
 
     logger.info("metadata", { metadata: metadata.current() });
 
-    await metadata.update({
+    await metadata.save({
       there: {
         is: {
           something: "here",
