Skip to content
effect-api-query
Menu
v0.0.0
Start Here
InstallationRPC Quick StartHTTP Quick StartExecutable ExamplesFeature SupportCompatibility and Stability
Guides
React QueryHTTP Queries and MutationsTanStack StartCache ManagementCancellationHandle FailuresCustom Key EncodersConditional Queries
Concepts
RPC Utility TreeHTTP Utility TreeQueries and MutationsClient LifecycleSemantic KeysData Normalization
Reference
RPC FactoryHTTP FactoryRPC BuildersErrorsPublic ExportsCompatibility and Limits

RPC Utility Tree

Understand how RPC tags become nested query utilities.

createRpcQueryUtils builds and freezes an RPC utility tree when you call it. It splits dotted unary and streaming RPC tags into nested paths:

RPC tag Generated path
users.get rpcQuery.users.get
projects.by-id.find rpcQuery.projects['by-id'].find
billing-history.list all rpcQuery['billing-history']['list all']

Each branch has key(). Unary leaves add ordinary query, infinite-query, and mutation builders. Streaming leaves add accumulated-stream and live-query builders. The factory builds the tree once and rejects invalid tags, collisions, and invalid encoder configuration during construction.

Reserved builder names cannot appear where they would collide with generated members. See Generated Builders for the leaf interface.