Simpler server rendering with apollo-client 1.x, using a local GraphQL networkInterface
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
tests
.eslintrc.js
.gitignore
.travis.yml
LICENSE
README.md
index.js
package.json
yarn.lock

README.md

apollo-local-query

Build Status

A local GraphQL networkInterface for apollo-client 1.x. If you're using Apollo Client 2.x and above, you probably want to use SchemaLink instead!

This is useful for server-rendering a React/Apollo app when your GraphQL server is running in the same server process. Rather than go out and back through the networking stack (eg. connecting to localhost), with this module the query runs in the same process as your rendering code.

Installation

npm install --save apollo-local-query

This module uses several ES6 features, so nodejs v6.0 or above is required.

Basic Usage

const {createLocalInterface} = require('apollo-local-query')
const graphql = require('graphql')
const schema = require('path/to/your/graphql_schema')

const isServer = ...
const options = { ... }     // Your common ApolloClient options

if (isServer) {
    options.networkInterface = createLocalInterface(graphql, schema)
    options.ssrMode = true
}

const myClient = new ApolloClient(options)

Note: If you're compiling your server-side code, GraphQL should be imported using the namespace import syntax, as the default import syntax will return undefined. For example:

import * as graphql from 'graphql';

Logging Queries

This module uses debug to enable optional logging. To log each query that runs through this local interface (along with its execution time), launch your server with the DEBUG env var set to apollo-local. For example, DEBUG=apollo-local npm start

License

MIT