Skip to content

Latest commit

 

History

History
68 lines (49 loc) · 2.76 KB

README.md

File metadata and controls

68 lines (49 loc) · 2.76 KB

MIT License PRs Welcome Watch on GitHub Star on GitHub Watch on GitHub Discord

A modular AST-based GraphQL request execution interface.

A hypothetical Link setup

Setting up a link

There are multiple ways to set up your link by using other links. Read more here.

Here's a simple example using Link.from:

import "package:gql_link/gql_link.dart";
import "package:gql_dedupe_link/gql_dedupe_link.dart";
import "package:gql_http_link/gql_http_link.dart";

import "./my_custom_link.dart";

void main () {
  final link = Link.from([
    MyCustomLink(),
    DedupeLink()
    HttpLink("/graphql"),
  ]);
}

To use a link to execute GraphQL operations, it must have been set up to end with a terminating link. In this case, it's HttpLink.

Using a link

When your link is set up, your GraphQL operation must be wrapped in a Request and executed via link.request(request);

Implementing a custom link

Links are designed to be composable. If you need to add a custom behavior, you can implement your own Link by extending the Link class. If you prefer functions over classes, you can use LinkFunction together with Link.function. If you have to route a request to some other links based on some set of conditions, Link.route(LinkRouter route) might be what you need.

Features and bugs

Please file feature requests and bugs at the GitHub.