oRPC Pinia Colada Integration
Seamlessly integrate oRPC with Pinia Colada for Vue.
SKILL.mdskills/orpc-pinia-colada/SKILL.md
GitHubPinia Colada Integration
Pinia Colada is the data fetching layer for Pinia and Vue.
Pinia Colada is unstable. This integration may introduce breaking changes.
Installation
npm install @orpc/vue-colada@latest @pinia/colada@latest
Setup
import { createORPCVueColadaUtils } from '@orpc/vue-colada'
export const orpc = createORPCVueColadaUtils(client)
orpc.planet.find.queryOptions({ input: { id: 123 } })
Avoiding Key Conflicts
const userORPC = createORPCVueColadaUtils(userClient, { path: ['user'] })
const postORPC = createORPCVueColadaUtils(postClient, { path: ['post'] })
Query Options
const query = useQuery(orpc.planet.find.queryOptions({
input: { id: 123 },
context: { cache: true },
}))
Mutation Options
const mutation = useMutation(orpc.planet.create.mutationOptions({
context: { cache: true },
}))
mutation.mutate({ name: 'Earth' })
Query/Mutation Key
const queryCache = useQueryCache()
queryCache.invalidateQueries({ key: orpc.planet.key() })
queryCache.invalidateQueries({ key: orpc.planet.find.key({ input: { id: 123 } }) })
Calling Procedure Clients
const result = orpc.planet.find.call({ id: 123 })
Error Handling
import { isDefinedError } from '@orpc/client'
const mutation = useMutation(orpc.planet.create.mutationOptions({
onError: (error) => {
if (isDefinedError(error)) {
// Handle the error
}
},
}))
mutation.mutate({ name: 'Earth' })
if (mutation.error.value && isDefinedError(mutation.error.value)) {
// Handle the error
}