/apollo-link

:link: Interface for fetching and modifying control flow of GraphQL requests

Primary LanguageTypeScriptMIT LicenseMIT

apollo-link npm version Get on Slack

Greenkeeper badge

apollo-link is a standard interface for modifying control flow of GraphQL requests and fetching GraphQL results, designed to provide a simple GraphQL client that is capable of extensions. The targeted use cases of apollo-link are highlighted below:

  • fetch queries directly without normalized cache
  • network interface for Apollo Client
  • network interface for Relay Modern
  • fetcher for GraphiQL

Installation

npm install apollo-link --save

To use apollo-link in a web browser or mobile app, you'll need a build system capable of loading NPM packages on the client. Some common choices include Browserify, Webpack, and Meteor +1.3.

Contributing

Apollo Link uses Lerna to manage multiple packages. To get started contributing, run npm run bootstrap which will install all dependencies and link together the projects.

Documentation

To start, begin by reading the getting started guide.

If you are interested in implementing your own links, read the implementation information.

Your feedback and contributions are welcome.

Apollo Principles

apollo-link strives to follow the Apollo design principles:

  1. Incrementally adoptable
  2. Universally compatible
  3. Simple to get started with
  4. Inspectable and understandable
  5. Built for interactive apps
  6. Small and flexible
  7. Community driven