James Ritchie
fade22015f
* Adds new features table to top of v4 upgrade guide * Adds wait idempotency to wait-until, wait-for, and wait-for-token pages * Adds new priority docs page and updates the v4 upgrade guide * Adds new task lifecycle hooks * Removes the message about requiring tasks to be exported * Adds new global lifecycle hooks section * Moves sections from upgrade guide into the table * Adds hidden task page * Improves the global lifecycle hooks section * Updates middleware and locals section * Adds new useWaitToken page to the react hooks section * Adds a new ai.tool section * Moves Docker (legacy) page into self-hosting section * Removes known issues from v4 upgrade guide * Replace “toolTask” with “ai.tool” in the Streams page example * Renames guide to “Migrating from v3” and adds redirect * Remove references to v4 * Removes changelog from migration guide * The installation guide now references `@latest update` * Changes all references from `/sdk/v3` to `/sdk` * Updates @v4-beta to @latest * Fixed broken link * Fixes broken link * Adds an upgrade to v4 using AI section * Fixes 2 broken links * Adds an entry for targetting preview branches * Updates the run statuses * Adds boolean helpers section to the runs and realtime pages * Updates the concurrency page * Updates the test page to include the new options * Adds SDK and curl options for the preview branch targeting * Updates new bulk actions page * Remove the releasing concurrency section * Got rid of some more @v4-beta mentions * Improved rate limit docs * Improved migrating docs * Removed commented sections of the docs * useWaitToken hook * Fixed the description * Fix for missing test image --------- Co-authored-by: Matt Aitken <matt@mattaitken.com> Co-authored-by: Dan <8297864+D-K-P@users.noreply.github.com>
35 lines
1.0 KiB
Plaintext
35 lines
1.0 KiB
Plaintext
---
|
|
title: useWaitToken
|
|
description: Use the useWaitToken hook to complete a wait token from a React component
|
|
---
|
|
|
|
We've added a new `useWaitToken` react hook that allows you to complete a wait token from a React component, using a Public Access Token.
|
|
|
|
```ts backend.ts
|
|
import { wait } from "@trigger.dev/sdk";
|
|
|
|
// Somewhere in your code, you'll need to create the token and then pass the token ID and the public token to the frontend
|
|
const token = await wait.createToken({
|
|
timeout: "10m",
|
|
});
|
|
|
|
return {
|
|
tokenId: token.id,
|
|
publicToken: token.publicAccessToken, // An automatically generated public access token that expires in 1 hour
|
|
};
|
|
```
|
|
|
|
Now you can use the `useWaitToken` hook in your frontend code:
|
|
|
|
```tsx frontend.tsx
|
|
import { useWaitToken } from "@trigger.dev/react-hooks";
|
|
|
|
export function MyComponent({ publicToken, tokenId }: { publicToken: string; tokenId: string }) {
|
|
const { complete } = useWaitToken(tokenId, {
|
|
accessToken: publicToken,
|
|
});
|
|
|
|
return <button onClick={() => complete({ foo: "bar" })}>Complete</button>;
|
|
}
|
|
```
|