Skip to content

Function: withConnection()

withConnection<TProcedure>(procedure): <TItem, TNode, TAdditionalInput>(options) => ConnectionProcedure<ConnectionInputWithAdditional<TAdditionalInput>, ConnectionResult<TNode>>

Defined in: fate/src/server/connection.ts:288

Wraps a tRPC procedure to handle cursor-based pagination with consistent connection semantics.

Type Parameters

TProcedure

TProcedure extends ProcedureLike

Parameters

procedure

TProcedure

Returns

<TItem, TNode, TAdditionalInput>(options): ConnectionProcedure<ConnectionInputWithAdditional<TAdditionalInput>, ConnectionResult<TNode>>

Type Parameters

TItem

TItem

TNode

TNode = TItem

TAdditionalInput

TAdditionalInput extends AdditionalInputSchema | undefined = undefined

Parameters

options

defaultSize?

number

getCursor?

(node) => string

input?

TAdditionalInput

map?

MapFn<ProcedureContext<TProcedure>, TItem, TNode, ConnectionInputWithAdditional<TAdditionalInput>>

query

QueryFn<ProcedureContext<TProcedure>, TItem, ConnectionInputWithAdditional<TAdditionalInput>>

Returns

ConnectionProcedure<ConnectionInputWithAdditional<TAdditionalInput>, ConnectionResult<TNode>>

Released under the MIT License