This is an extension library that only has a peer dependency to piral-core
. What piral-urql
brings to the table is a set of API extensions that is used by piral
. The set represents a powerful GraphQL integration using the open-source library URQL.
Documentation
For details on the provided API check out the documentation at the Piral website or on GitHub.
Setup and Bootstrapping
The provided library only brings API extensions for pilets to a Piral instance.
For the setup of the library itself you'll need to import createGqlApi
from the piral-urql
package.
import { createGqlApi } from 'piral-urql';
The integration looks like:
const instance = createInstance({
extendApi: [createGqlApi()],
});
Via the options the correct client can be set up. Setting the subscriptionUrl
to false
will prevent using a subscription.
For example:
const client = setupGqlClient({
url: 'https://example.com/graphql',
subscriptionUrl: false,
lazy: true,
});
const instance = createInstance({
extendApi: [createGqlApi(client)],
});
License
Piral is released using the MIT license. For more information see the license file.