useMutation()
The hooks provided by
@trpc/react
are a thin wrapper around React Query. For in-depth information about options and usage patterns, refer to their docs on Mutations.
Works like react-query's mutations - see their docs.
Example
Backend code
server/routers/_app.ts
import * as trpc from '@trpc/server';
import { z } from 'zod';
export const appRouter = trpc.router()
// Create procedure at path 'login'
// The syntax is identical to creating queries
.mutation('login', {
// using zod schema to validate and infer input values
input: z
.object({
name: z.string(),
})
async resolve({ input }) {
// Here some login stuff would happen
return {
user: {
name: input.name,
role: 'ADMIN'
},
};
},
})
import { trpc } from '../utils/trpc';
export function MyComponent() {
// This can either be a tuple ['login'] or string 'login'
const mutation = trpc.useMutation(['login']);
const handleLogin = async () => {
const name = 'John Doe';
mutation.mutate({ name });
};
return (
<div>
<h1>Login Form</h1>
<button onClick={handleLogin} disabled={mutation.isLoading}>Login</button>
{mutation.error && <p>Something went wrong! {mutation.error.message}</p>}
</div>
);
}