Skip to main content
Home
Browse packagesDocsSign in

@urql/core@6.0.1
Built and signed on GitHub Actions

latest
urql-graphql/urql
Works with
This package works with Cloudflare Workers, Node.js, Bun, Browsers
This package works with Cloudflare Workers
This package works with Node.js
This package works with Bun
This package works with Browsers
•JSR Score94%•
Downloads4/wk
•
Published5 months ago (6.0.1)

The shared core for the highly customizable and versatile GraphQL client

interface Client

The Client is the central hub for your GraphQL operations and holds urql's state.

Properties

Exposes the stream of Operations that is passed to the Exchange pipeline.

Flag indicating whether support for “Suspense” is activated.

Methods

reexecuteOperation(operation: Operation): void

Dispatches an Operation to the Exchange pipeline, if this Operation is active.

optional
subscribeToDebugTarget(onEvent: (event: DebugEvent) => void): Subscription

Subscribe method to add an event listener to debug events.

createRequestOperation<
Data = any,
Variables extends AnyVariables = AnyVariables,
>(
request: GraphQLRequest<Data, Variables>,
opts?: Partial<OperationContext> | undefined,
): Operation<Data, Variables>

Creates an Operation from a GraphQLRequest and optionally, overriding OperationContext options.

executeRequestOperation<
Data = any,
Variables extends AnyVariables = AnyVariables,
>(operation: Operation<Data, Variables>): OperationResultSource<OperationResult<Data, Variables>>

Creates a Source that executes the Operation and issues OperationResults for this Operation.

query<
Data = any,
Variables extends AnyVariables = AnyVariables,
>(
query: DocumentInput<Data, Variables>,
variables: Variables,
context?: Partial<OperationContext>,
): OperationResultSource<OperationResult<Data, Variables>>

Creates a Source that executes the GraphQL query operation created from the passed parameters.

readQuery<
Data = any,
Variables extends AnyVariables = AnyVariables,
>(
query: DocumentInput<Data, Variables>,
variables: Variables,
context?: Partial<OperationContext>,
): OperationResult<Data, Variables> | null

Returns the first synchronous result a Client provides for a given operation.

executeQuery<
Data = any,
Variables extends AnyVariables = AnyVariables,
>(
query: GraphQLRequest<Data, Variables>,
opts?: Partial<OperationContext> | undefined,
): OperationResultSource<OperationResult<Data, Variables>>

Creates a Source that executes the GraphQL query operation for the passed GraphQLRequest.

subscription<
Data = any,
Variables extends AnyVariables = AnyVariables,
>(
query: DocumentInput<Data, Variables>,
variables: Variables,
context?: Partial<OperationContext>,
): OperationResultSource<OperationResult<Data, Variables>>

Creates a Source that executes the GraphQL subscription operation created from the passed parameters.

executeSubscription<
Data = any,
Variables extends AnyVariables = AnyVariables,
>(
query: GraphQLRequest<Data, Variables>,
opts?: Partial<OperationContext> | undefined,
): OperationResultSource<OperationResult<Data, Variables>>

Creates a Source that executes the GraphQL subscription operation for the passed GraphQLRequest.

mutation<
Data = any,
Variables extends AnyVariables = AnyVariables,
>(
query: DocumentInput<Data, Variables>,
variables: Variables,
context?: Partial<OperationContext>,
): OperationResultSource<OperationResult<Data, Variables>>

Creates a Source that executes the GraphQL mutation operation created from the passed parameters.

executeMutation<
Data = any,
Variables extends AnyVariables = AnyVariables,
>(
query: GraphQLRequest<Data, Variables>,
opts?: Partial<OperationContext> | undefined,
): OperationResultSource<OperationResult<Data, Variables>>

Creates a Source that executes the GraphQL mutation operation for the passed GraphQLRequest.

See

Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

pnpm i jsr:@urql/core
or (using pnpm 10.8 or older)
pnpm dlx jsr add @urql/core

Import symbol

import { Client } from "@urql/core";

Add Package

yarn add jsr:@urql/core
or (using Yarn 4.8 or older)
yarn dlx jsr add @urql/core

Import symbol

import { Client } from "@urql/core";

Add Package

vlt install jsr:@urql/core

Import symbol

import { Client } from "@urql/core";

Add Package

npx jsr add @urql/core

Import symbol

import { Client } from "@urql/core";

Add Package

bunx jsr add @urql/core

Import symbol

import { Client } from "@urql/core";