Skip to content
result-rpc
Esc
navigateopen⌘Jpreview
On this page

Introduction

Typed RPC for React. Errors accumulate along the call path and discharge along the component tree.

result-rpc is an RPC layer for React in the tRPC tradition — contract in TypeScript, procedures on the server, hooks in components — with one foundational change: every way an operation can fail is a typed, wire-safe value in that operation’s own closed union, and responsibility for each failure is assigned to exactly one place in the component tree.

Results are better-result 3.0’s errors-as-values runtime — Ok/Err class instances, upstream composition, Result.codec, generator behavior, Panic semantics. result-rpc adds the RPC boundary: only declared, serializable, reifiable tagged errors may enter or leave a procedure. A better-result Result whose error is already a result-rpc tagged error flows into a handler unchanged; a foreign error folds with mapError before the boundary.

Expected failures are part of the contract. Unexpected exceptions are not. Procedures return anticipated failures as tagged values in their declared Result. Unexpected server exceptions are reported through onInternalError with their private cause and exposed to clients only as a sanitized server/internal failure. Declared failures produce structured Result events; exceptions remain incident signals.

The problem it addresses shows up once an app is a few years old. Offline behavior, 5xx handling, session expiry, and observability stop being polish and become the work, and you end up threading them through every query and mutation, or bolting them on with onError defaults, axios-style interceptors, and a Sentry integration that guesses at what happened. This library treats those cases as ordinary values with declared owners, and emits observability as a structured stream rather than something you reconstruct after the fact.

If you looked at Effect for this and decided it was more than you wanted, the overlapping parts are here — typed errors, services, layers — with a smaller API surface and hooks that look like the ones you already write.

If you tried the halfway version — neverthrow or better-result on the server, procedures returning Result as data — you know where it stops: tagged errors are only shallowly serialized, so their runtime API dies at the serializer, and on the client query.error becomes a different thing from query.data.error. This library starts there: it validates the plain wire form, then reconstructs both the Result and its real TaggedError instance on the client.

const query = useResultQuery(client.doc.byId, { id: "doc_123" });

if (query.state === "failure") {
  // DocNotFound | Unauthorized | ServerInternal | Offline | NetworkFailure |
  // Timeout | HttpFailure | ProtocolViolation | DecodeFailure | Stale
  query.error;
}

Ten tags looks like a lot until you notice they are not new failure modes — they are the ones your stack already has, mostly unnamed. With tRPC’s standard model, returned domain failures live in procedure data while thrown server, framework, and transport failures use the query error channel. A custom error formatter can enrich that shared channel, but it does not combine both halves into one exact per-procedure Result union. result-rpc’s union is the same reality, admitted, in one place, closed. And no component has to branch on all of it, because the same union is narrowed by what the tree already takes responsibility for:

const query = AuthShell.useQuery(client.doc.byId, { id: "doc_123" });

if (query.state === "failure") {
  // DocNotFound
  query.error;
}

Nothing was hidden. Unauthorized is gone because an enclosing shell guarantees a session and redirects when that stops being true. The transport tags are gone because the app shell owns the offline banner. The protocol tags are gone because they escalate to an error boundary. Each shell subtracts exactly what it takes responsibility for, and it does so in the type.

The pieces, in the order this document builds them:

  1. A wire contract — procedures, codecs, and tagged errors declared once, shared by both sides; rich values survive the wire.
  2. Middleware and services — request context that grows as middleware adds guarantees; process-lifetime resources resolved once as a dependency graph.
  3. A direct client whose every call resolves Result<T, ExactUnion> — never a thrown transport error on the side. Shell-owned mutation control and cancellation remain separate non-failure signals.
  4. A Result-native query cache — caching, retries, optimistic updates, SSR, all speaking Result.
  5. Shells — error boundaries for values: providers that own classes of failure and subtract them from the unions components see.

Routing, SSR frameworks, and bundling are explicitly not on the list — shells are providers and hooks, so they compose with whatever owns the tree.

Status: 0.3.0 is published with npm provenance. The project is pre-1.0, so its API may still change between minor releases. Everything documented here is implemented and tested, and the examples/ directory is runnable.

The two problems

Problem one: two failure channels

You have written this component. Domain failures come back as data; transport failures come back somewhere else:

const query = useQuery({
  queryFn: () => rpc.doc.byId.query({ id }),
});

query.data;
// Result<Doc, DocNotFound | Unauthorized> | undefined

query.error;
// TRPCClientError | null — a separate, framework-wide error shape

Domain failures are successful query data. Network and thrown server failures use the query error channel. Retries, error boundaries, offline behavior, and exhaustive matching now operate on different halves of the same operation. A formatter can enrich the framework-wide error shape, but it does not give each procedure its own closed E union.

Every good team patches this, and each patch is a known move:

  • Discipline. Decree that query.error is transport-only and return a discriminated union as data. Now the cache’s machinery — retries, error boundaries, offline pausing — operates on the half your domain errors are not in, exhaustive matching operates on the half your transport errors are not in, and every component maps every tag by hand, because nothing ever narrows.
  • Encoding. superjson-encode the Result objects across the wire. You get Result-shaped JSON, not a contract: no closed union per procedure, no exhaustiveness, no retry or status policy attached to the error.
  • Interception. A global onError callback on the client. That is problem two.

result-rpc makes the operation the unit of composition:

type GetDocError =
  | DocNotFound
  | Unauthorized
  | ServerInternal
  | Offline
  | NetworkFailure
  | Timeout
  | HttpFailure
  | ProtocolViolation
  | DecodeFailure
  | Stale;

The shared contract declares server and middleware errors. The client boundary adds transport and protocol errors. The query runtime preserves the full union while handling caching, retries, pausing, hydration, and cancellation.

Problem two: the 401 interceptor

A complete union is honest, but exhaustiveness is not relevance. A component that renders a document has business with DocNotFound. It has no business deciding what happens when the network is down or the session is revoked mid-render.

Unauthorized is the halfway house that exposes this. It is domain-shaped — declared, typed, expected by every procedure that requires a session — and it is ambient: it can surface on any call, and no document component should carry branching logic for what sign-out looks like. The domain bucket taxes every component with it; the transport bucket makes it stringly. Neither holds it — and it is not alone: plan limits, org suspension, maintenance windows, read-only mode all have the same shape, declared like domain errors but owned like infrastructure. So every app that survives contact with production grows one of these:

// somewhere global, in every codebase, in some costume
queryClient.setDefaultOptions({
  queries: {
    onError: (error) => {
      if ((error as any)?.data?.httpStatus === 401) {
        window.location.href = "/login";
      }
    },
  },
});

A global, stringly hook, invisible to the type system, that fires once per in-flight query, races the components’ own error branches, and blanks whatever the user was looking at. The disciplined version — a cache-level handler plus per-query meta flags to suppress it on the login screen — is the same move with more indirection, and it double-fires and races the same way. Both exist because the alternative — handling session expiry in every component that fetches — is worse.

The requirement the interceptor cannot express is that ownership depends on where you are: the app shell should own Unauthorized almost everywhere, while the one login-adjacent screen that wants to render it inline takes it back. result-rpc keeps the union complete at the contract and replaces the interceptor with a typed, tree-positional owner: a shell declares, in one place, which tags it takes responsibility for, and those tags leave the union every component beneath it sees — while a component rendered outside the shell (or using the unnarrowed hook) sees the full union again. Handling a tag or delegating it is a choice made by position, and the type at every call site shows which choice is in force. That is the Shells section, and it is the reason the rest of the machinery exists.

What result-rpc owns

Concern result-rpc contract
Result composition Plain Result values, gen/yield*, tryPromise, union-preserving combinators, exhaustive matching
Error definitions Namespaced tags, wire codecs, HTTP/retry/visibility policy
RPC Procedures, middleware, routers, server execution, protocol, clients
Transport failures Tagged additions to each procedure’s inferred error union
Query runtime Keys, caching, retries, invalidation, lifecycle, hydration
Failure ownership Shells that subtract claimed errors and guarantee context
React Query, mutation, subscription, suspense, and SSR bindings
Diagnostics Safe incident IDs publicly; full causes only in local observability
Observability Wire event stream, claim breadcrumbs, policy-aware server taps, Result taps
Cache coherence Entity identities (patch by model+id), declared invalidation, membership via .affects
Forms Validator-as-wire-codec adoption, plus server-issue → field projection

The query engine uses @tanstack/query-core privately. That is an engine choice, not part of the public API. Applications do not install or compose better-result, tRPC, or React Query around result-rpc.

Was this page helpful?