piral-urql/lib/queries.d.ts

Plugin for providing a GraphQL client in Piral.

import { Client } from 'urql';
import { GqlQueryOptions, GqlMutationOptions, GqlSubscriber, GqlSubscriptionOptions } from './types';
/**
 * Executes a new GraphQL query.
 * @param client The client to use as base.
 * @param q The GraphQL query to run.
 * @param options The options for the query.
 */
export declare function gqlQuery<TResult = any>(client: Client, q: string, options?: GqlQueryOptions): Promise<TResult>;
/**
 * Executes a new GraphQL mutation.
 * @param client The client to use as base.
 * @param q The GraphQL mutation to run.
 * @param options The options for the mutation.
 */
export declare function gqlMutation<TResult = any>(client: Client, q: string, options?: GqlMutationOptions): Promise<TResult>;
/**
 * Establishes a new GraphQL subscription.
 * @param client The client to use as base.
 * @param q The GraphQL subscription to establish.
 * @param subscriber The callback when new data has arrived.
 * @param options The options for the query.
 */
export declare function gqlSubscription<TResult = any>(client: Client, q: string, subscriber: GqlSubscriber<TResult>, options?: GqlSubscriptionOptions): () => void;