trpcgo

Jun 3, 2026

Changes in this version

type Option

+ func WithEnumsOutput(path string) Option

Mar 16, 2026

Changes in this version

+ func ApplyResponseMetadata(ctx context.Context, w http.ResponseWriter)

+ func IsStreamResult(result any) bool

+ func MustSubscribeWithFinal[I any, O any](r *Router, path string, ...)

+ func MustVoidSubscribeWithFinal[O any](r *Router, path string, ...)

+ func NewResultEnvelope(data any) any

+ func SubscribeWithFinal[I any, O any](r *Router, path string, ...) error

+ func VoidSubscribeWithFinal[O any](r *Router, path string, ...) error

+ func WithProcedureMeta(ctx context.Context, pm ProcedureMeta) context.Context

+ type Blob struct

+ Name string

+ Type string

+ func NewBlob(data []byte, name, mimeType string) Blob

+ func (b *Blob) UnmarshalJSON(p []byte) error

+ func (b Blob) Bytes() []byte

+ func (b Blob) Len() int

+ func (b Blob) MarshalJSON() ([]byte, error)

+ func (b Blob) Reader() io.Reader

type Error

+ func SanitizeError(err error) *Error

type ErrorEnvelope

+ func DefaultErrorEnvelope(err *Error, path string, isDev bool) ErrorEnvelope

+ type ProcedureEntry struct

+ func (e *ProcedureEntry) InputType() reflect.Type

+ func (e *ProcedureEntry) Meta() any

+ func (e *ProcedureEntry) OutputType() reflect.Type

+ func (e *ProcedureEntry) Route() Route

+ func (e *ProcedureEntry) Type() ProcedureType

+ type ProcedureMap struct

+ func (pm *ProcedureMap) All() iter.Seq2[string, *ProcedureEntry]

+ func (pm *ProcedureMap) Len() int

+ func (pm *ProcedureMap) Lookup(path string) (*ProcedureEntry, bool)

type ProcedureOption

+ func WithDeprecated(deprecated bool) ProcedureOption

+ func WithDescription(description string) ProcedureOption

+ func WithOperationID(id string) ProcedureOption

+ func WithRoute(method, path string) ProcedureOption

+ func WithSuccessStatus(status int) ProcedureOption

+ func WithSummary(summary string) ProcedureOption

+ func WithTags(tags ...string) ProcedureOption

+ type Route struct

+ Deprecated bool

+ Description string

+ Method string

+ OperationID string

+ Path string

+ SuccessStatus int

+ Summary string

+ Tags []string

type Router

+ func (r *Router) AllowBatching() bool

+ func (r *Router) AllowMethodOverride() bool

+ func (r *Router) BuildProcedureMap() *ProcedureMap

+ func (r *Router) ContextCreator() func(context.Context, *http.Request) context.Context

+ func (r *Router) ErrorCallback() func(context.Context, *Error, string)

+ func (r *Router) ErrorFormatter() func(ErrorFormatterInput) any

+ func (r *Router) ExecuteEntry(ctx context.Context, entry *ProcedureEntry, raw json.RawMessage) (any, error)

+ func (r *Router) FormatError(err *Error, path string, input json.RawMessage, ctx context.Context, ...) any

+ func (r *Router) GenerateORPC(outputPath string) error

+ func (r *Router) IsDev() bool

+ func (r *Router) MaxBatchSize() int

+ func (r *Router) MaxBodySize() int64

+ func (r *Router) MaxSSEConnections() int

+ func (r *Router) SSEMaxDuration() time.Duration

+ func (r *Router) SSEPingInterval() time.Duration

+ func (r *Router) SSEReconnectAfterInactivityMs() int

+ func (r *Router) StartDevWatcher()

+ func (r *Router) StrictInput() bool

+ func (r *Router) TrackSSEConnection(delta int64) int64

+ func (r *Router) Validator() func(any) error

+ type StreamConsumer struct

+ func ConsumeStream(result any) *StreamConsumer

+ func (sc *StreamConsumer) Recv(ctx context.Context) (data any, id string, retry int, err error)

type TrackedEvent

+ Retry int

Mar 5, 2026

Changes in this version

type ProcedureBuilder

+ func (b *ProcedureBuilder) With(opts ...ProcedureOption) *ProcedureBuilder

+ func (b *ProcedureBuilder) WithOutputParser(fn func(any) (any, error)) *ProcedureBuilder

+ func (b *ProcedureBuilder) WithOutputValidator(fn func(any) error) *ProcedureBuilder

type ProcedureOption

+ func OutputParser[O, P any](fn func(O) (P, error)) ProcedureOption

+ func OutputValidator[O any](fn func(O) error) ProcedureOption

+ func WithOutputParser(fn func(any) (any, error)) ProcedureOption

+ func WithOutputValidator(fn func(any) error) ProcedureOption

Mar 5, 2026

Changes in this version

+ type ProcedureBuilder struct

+ func Procedure(base ...ProcedureOption) *ProcedureBuilder

+ func (b *ProcedureBuilder) Use(mw ...Middleware) *ProcedureBuilder

+ func (b *ProcedureBuilder) WithMeta(meta any) *ProcedureBuilder

Mar 5, 2026

Changes in this version

+ func MustMutation[I any, O any](r *Router, path string, fn func(ctx context.Context, input I) (O, error), ...)

+ func MustQuery[I any, O any](r *Router, path string, fn func(ctx context.Context, input I) (O, error), ...)

+ func MustSubscribe[I any, O any](r *Router, path string, ...)

+ func MustVoidMutation[O any](r *Router, path string, fn func(ctx context.Context) (O, error), ...)

+ func MustVoidQuery[O any](r *Router, path string, fn func(ctx context.Context) (O, error), ...)

+ func MustVoidSubscribe[O any](r *Router, path string, fn func(ctx context.Context) (<-chan O, error), ...)

type ErrorFormatterInput

+ Input json.RawMessage

type Option

+ func WithWatchPackages(patterns ...string) Option

Mar 2, 2026

Changes in this version

+ func GetMeta[T any](ctx context.Context) (T, bool)

+ type ErrorEnvelope struct

+ Error ErrorShape

+ type ErrorShape struct

+ Code ErrorCode

+ Data ErrorShapeData

+ Message string

+ type ErrorShapeData struct

+ Code string

+ HTTPStatus int

+ Path string

+ Stack string

type Option

+ func WithSSEMaxConnections(n int) Option

type Router

+ func (r *Router) Close() error

Mar 2, 2026

Changes in this version

type Router

+ func (r *Router) GenerateZod(outputPath string) error

Mar 2, 2026

Changes in this version

type Option

+ func WithStrictInput(enabled bool) Option

Mar 2, 2026

Changes in this version

+ func Call[I any, O any](r *Router, ctx context.Context, path string, input I) (O, error)

+ func GetResponseCookies(ctx context.Context) []*http.Cookie

+ func GetResponseHeaders(ctx context.Context) http.Header

+ func HTTPStatusFromCode(code ErrorCode) int

+ func Mutation[I any, O any](r *Router, path string, fn func(ctx context.Context, input I) (O, error), ...)

+ func NameFromCode(code ErrorCode) string

+ func Query[I any, O any](r *Router, path string, fn func(ctx context.Context, input I) (O, error), ...)

+ func SetCookie(ctx context.Context, c *http.Cookie)

+ func SetResponseHeader(ctx context.Context, key, value string)

+ func Subscribe[I any, O any](r *Router, path string, ...)

+ func VoidMutation[O any](r *Router, path string, fn func(ctx context.Context) (O, error), ...)

+ func VoidQuery[O any](r *Router, path string, fn func(ctx context.Context) (O, error), ...)

+ func VoidSubscribe[O any](r *Router, path string, fn func(ctx context.Context) (<-chan O, error), ...)

+ func WithResponseMetadata(ctx context.Context) context.Context

+ type Error struct

+ Cause error

+ Code ErrorCode

+ Message string

+ func NewError(code ErrorCode, message string) *Error

+ func NewErrorf(code ErrorCode, format string, args ...any) *Error

+ func WrapError(code ErrorCode, message string, cause error) *Error

+ func (e *Error) Error() string

+ func (e *Error) Unwrap() error

+ type ErrorCode int

+ const CodeBadGateway

+ const CodeBadRequest

+ const CodeClientClosed

+ const CodeConflict

+ const CodeForbidden

+ const CodeGatewayTimeout

+ const CodeInternalServerError

+ const CodeMethodNotSupported

+ const CodeNotFound

+ const CodeNotImplemented

+ const CodeParseError

+ const CodePayloadTooLarge

+ const CodePreconditionFailed

+ const CodePreconditionRequired

+ const CodeServiceUnavailable

+ const CodeTimeout

+ const CodeTooManyRequests

+ const CodeUnauthorized

+ const CodeUnprocessableContent

+ const CodeUnsupportedMedia

+ type ErrorFormatterInput struct

+ Ctx context.Context

+ Error *Error

+ Path string

+ Shape errorEnvelope

+ Type ProcedureType

+ type HandlerFunc func(ctx context.Context, input any) (any, error)

+ type Middleware func(next HandlerFunc) HandlerFunc

+ func Chain(mws ...Middleware) Middleware

+ type Option func(*routerOptions)

+ func WithBatching(enabled bool) Option

+ func WithContextCreator(fn func(r *http.Request) context.Context) Option

+ func WithDev(enabled bool) Option

+ func WithErrorFormatter(fn func(ErrorFormatterInput) any) Option

+ func WithMaxBatchSize(n int) Option

+ func WithMaxBodySize(n int64) Option

+ func WithMethodOverride(enabled bool) Option

+ func WithOnError(fn func(ctx context.Context, err *Error, path string)) Option

+ func WithSSEMaxDuration(d time.Duration) Option

+ func WithSSEPingInterval(d time.Duration) Option

+ func WithSSEReconnectAfterInactivity(d time.Duration) Option

+ func WithTypeOutput(path string) Option

+ func WithValidator(fn func(any) error) Option

+ func WithZodMini(enabled bool) Option

+ func WithZodOutput(path string) Option

+ type ProcedureMeta struct

+ Meta any

+ Path string

+ Type ProcedureType

+ func GetProcedureMeta(ctx context.Context) (ProcedureMeta, bool)

+ type ProcedureOption func(*procedureConfig)

+ func Use(mw ...Middleware) ProcedureOption

+ func WithMeta(meta any) ProcedureOption

+ type ProcedureType string

+ const ProcedureMutation

+ const ProcedureQuery

+ const ProcedureSubscription

+ type Router struct

+ func MergeRouters(routers ...*Router) *Router

+ func NewRouter(opts ...Option) *Router

+ func (r *Router) GenerateTS(outputPath string) error

+ func (r *Router) Handler(basePath string) http.Handler

+ func (r *Router) Merge(sources ...*Router)

+ func (r *Router) RawCall(ctx context.Context, path string, input json.RawMessage) (any, error)

+ func (r *Router) Use(mw ...Middleware)

+ type TrackedEvent struct

+ Data T

+ ID string

+ func Tracked[T any](id string, data T) TrackedEvent[T]