SDK reference
SDK reference
Every public export of the @synqauth/* packages, from their own doc comments.
The @synqauth/* packages, each export with its signature and what it does, generated from the packages' own doc comments. They are on npm at 0.x, so a minor release can change their API. See the changelog for what changed.
| Package | What it is |
|---|---|
@synqauth/js | Synq's framework-agnostic client: sign-in and sessions in the browser, the account API, and token and webhook verification on your server. |
@synqauth/nextjs | Synq for Next.js: a backend-for-frontend session, so the browser never holds a Synq token. |
@synqauth/react | React hooks and components for Synq. |
@synqauth/react-native | Synq for React Native: sign-in through the system browser, with tokens in the device's secure storage. |
@synqauth/solana | Sign in to Synq with a Solana wallet, on the Wallet Standard. |
@synqauth/solana-mobile | Sign in to Synq with a Solana wallet app on Android, through Mobile Wallet Adapter. |
@synqauth/plugin-siws | A Synq plugin for Sign In With Solana from your own UI. |
@synqauth/plugin-passkey | A Synq plugin for passkeys from your own UI. |
@synqauth/plugin-magic-link | A Synq plugin that sends people from your own UI to the hosted page's emailed code or magic link. |
Name a wallet, or make it primary PATCH
Its label (null clears it), and `primary: true` makes it their primary wallet in place of the one that was. Needs `me:write`. Recorded as `user.updated`.
@synqauth/js
Synq's framework-agnostic client: sign-in and sessions in the browser, the account API, and token and webhook verification on your server.