apollo-link-webextensions-messaging
v1.0.4-rc.0
Published
> Apollo link that, in a WebExtension, forwards GraphQL operations between processes
Downloads
5
Keywords
Readme
apollo-link-webextensions-messaging
Apollo link that, in a WebExtension, forwards GraphQL operations between processes
Install
npm i -S apollo-link-webextensions-messaging
Features
- Supports response streaming. Perfect to use with
reactive-graphql
andapollo-link-reactive-schema
- Compatible with Chrome Extensions and Web Extensions APIs
- Independent of
Port
creation method: adaptable for cross-extension messaging or native messaging - Messaging context passing: use messaging
Port
(and esp.MessageSender
) in local GraphQL resolvers
Usage
// ------------------
// in background page
import { createWebExtensionMessagingExecutorListener } from 'apollo-link-webextensions-messaging';
import { SchemaLink } from 'apollo-link-schema';
import schema from './path/to/your/schema';
// local schema execution
const link = new SchemaLink({
schema,
context: operation => ({
// `createWebExtensionMessagingExecutorListener` will
// add `port`, the `onConnect`'s `Port` as Operation's context
// we extract the `MessageSender` into GQL's context so that
// it can be used in resolvers
sender: operation.getContext().port.sender,
})
});
const listener = createWebExtensionMessagingExecutorListener({
link,
});
chrome.runtime.onConnect.addListener(listener);
// ----------------
// in content script
import { createWebExtensionsMessagingLink } from 'apollo-link-webextensions-messaging';
import { ApolloClient } from 'apollo-client';
import { InMemoryCache } from 'apollo-cache-inmemory';
const port = chrome.runtime.connect();
const client = new ApolloClient({
// can also be `createWebExtensionsMessagingLink((operation) => port)`
link: createWebExtensionsMessagingLink(port),
cache: new InMemoryCache(),
// from experience, if `queryDeduplication` is true,
// `client.watchQuery` unsubscription will not be
// properly passed down to the `link`
queryDeduplication: false,
});
client.query(MY_QUERY);