Class: TRPCUntypedClient<TInferrable>

Defined in: packages/client/src/internals/TRPCUntypedClient.ts:114

A client that calls procedures by path string, without types. createTRPCClient wraps one.

Type Parameters

Type Parameter
`TInferrable` extends `InferrableClientTypes`

Constructors

new TRPCUntypedClient()

new TRPCUntypedClient<TInferrable>(opts): TRPCUntypedClient<TInferrable>

Defined in: packages/client/src/internals/TRPCUntypedClient.ts:119

Parameters

Parameter	Type
`opts`	`CreateTRPCClientOptions`<`TInferrable`>

Returns

TRPCUntypedClient<TInferrable>

Properties

runtime

readonly runtime: TRPCClientRuntime

Defined in: packages/client/src/internals/TRPCUntypedClient.ts:116

Methods

mutation()

mutation(path, input?, opts?): Promise<unknown>

Defined in: packages/client/src/internals/TRPCUntypedClient.ts:175

Calls a mutation.

Parameters

Parameter	Type
`path`	`string`
`input`?	`unknown`
`opts`?	`TRPCRequestOptions`

Returns

Promise<unknown>

query()

query(path, input?, opts?): Promise<unknown>

Defined in: packages/client/src/internals/TRPCUntypedClient.ts:165

Calls a query.

Parameters

Parameter	Type
`path`	`string`
`input`?	`unknown`
`opts`?	`TRPCRequestOptions`

Returns

Promise<unknown>

subscription()

Call Signature

subscription(path, input, opts): Unsubscribable

Defined in: packages/client/src/internals/TRPCUntypedClient.ts:190

Starts a subscription. With callbacks, returns what stops it. Without, returns an async iterator to read it with for await, which signal, break or return() stops. It can be iterated once.

Parameters

Parameter	Type
`path`	`string`
`input`	`unknown`
`opts`	`TRPCSubscriptionCallbacks`<`unknown`, `TRPCClientError`<`AnyRouter`>> & `TRPCRequestOptions`

Returns

Unsubscribable

See

https://trpc.io/docs/client/vanilla/setup#5-use-subscriptions

Call Signature

subscription<TOpts>(path, input, opts?): AsyncIterableIterator<unknown>

Defined in: packages/client/src/internals/TRPCUntypedClient.ts:196

Starts a subscription. With callbacks, returns what stops it. Without, returns an async iterator to read it with for await, which signal, break or return() stops. It can be iterated once.

Type Parameters

Type Parameter	Default type
`TOpts` extends `TRPCRequestOptions` & `Partial`<`TRPCSubscriptionObserver`<`unknown`, `TRPCClientError`<`AnyRouter`>>>	`TRPCRequestOptions`

Parameters

Parameter	Type
`path`	`string`
`input`	`unknown`
`opts`?	`TRPCSubscriptionWithoutCallbacks`<`TOpts`>

Returns

AsyncIterableIterator<unknown>

See

https://trpc.io/docs/client/vanilla/setup#5-use-subscriptions