Skip to content
tRPC

Partners

Interface: TRPCSubscriptionIdleResult<TOutput>

On this page

Defined in: tanstack-react-query/src/internals/subscriptionOptions.ts:124

Result while the subscription is not running.

Extends

  • TRPCSubscriptionBaseResult<TOutput, null>

Type Parameters

Type Parameter
TOutput

Properties

data

data: undefined

Defined in: tanstack-react-query/src/internals/subscriptionOptions.ts:128

The last data received.

Overrides

TRPCSubscriptionBaseResult.data


error

error: null

Defined in: tanstack-react-query/src/internals/subscriptionOptions.ts:129

The last error, if any.

Overrides

TRPCSubscriptionBaseResult.error


reset()

reset: () => void

Defined in: tanstack-react-query/src/internals/subscriptionOptions.ts:118

Reset the subscription

Returns

void

Inherited from

TRPCSubscriptionBaseResult.reset


status

status: "idle"

Defined in: tanstack-react-query/src/internals/subscriptionOptions.ts:127

Where the subscription is in its lifecycle.

Overrides

TRPCSubscriptionBaseResult.status