Skip to content

Commit 4d1c592

Browse files
committed
docs(management): make TriggerClient snippets self-contained
Define `payload` and surface the `emailTask` type import so the example snippets across overview, multiple-clients, and preview branches docs run as pasted.
1 parent 5b5e9af commit 4d1c592

3 files changed

Lines changed: 6 additions & 1 deletion

File tree

docs/deployment/preview-branches.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ const checkout = new TriggerClient({
8282
previewBranch: "checkout-redesign",
8383
});
8484

85+
const payload = { to: "user@example.com" };
8586
await Promise.all([
8687
signupFlow.tasks.trigger("send-email", payload),
8788
checkout.tasks.trigger("send-email", payload),

docs/management/multiple-clients.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ const preview = new TriggerClient({
1515
previewBranch: "signup-flow",
1616
});
1717

18+
const payload = { to: "user@example.com" };
1819
await prod.tasks.trigger("send-email", payload);
1920
await preview.runs.list({ status: ["COMPLETED"] });
2021
```
@@ -50,9 +51,11 @@ If no `accessToken` resolves from either the constructor or env vars, the first
5051
Each instance exposes the management surface as namespaced properties: `tasks`, `runs`, `batch`, `schedules`, `envvars`, `queues`, `deployments`, `prompts`, and `auth`.
5152

5253
```ts
54+
import type { emailTask } from "./trigger/email";
55+
5356
const client = new TriggerClient();
5457

55-
await client.tasks.trigger<typeof emailTask>("send-email", { to: "..." });
58+
await client.tasks.trigger<typeof emailTask>("send-email", { to: "user@example.com" });
5659
await client.runs.list({ status: ["COMPLETED"], limit: 10 });
5760
await client.schedules.create({ task: "daily-report", cron: "0 9 * * *" });
5861
await client.envvars.update("proj_1234", "preview", "DATABASE_URL", { value: "..." });

docs/management/overview.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ const preview = new TriggerClient({
5959
previewBranch: "signup-flow",
6060
});
6161

62+
const payload = { to: "user@example.com" };
6263
await prod.tasks.trigger("send-email", payload);
6364
await preview.runs.list({ status: ["COMPLETED"] });
6465
```

0 commit comments

Comments
 (0)