trpc-extension v1.1.0

Chrome extension support for tRPC 🧩

• Easy communication for web extensions.
• Typesafe messaging between window, content & background scripts.
• Ready for Manifest V3.

Usage

1. Install trpc-chrome.

# npm
npm install trpc-chrome
# yarn
yarn add trpc-chrome

2. Add createChromeHandler in your background script.

// background.ts
import { initTRPC } from '@trpc/server';
import { createChromeHandler } from 'trpc-chrome/adapter';

const t = initTRPC.create({
  isServer: false,
  allowOutsideOfServer: true,
});

const appRouter = t.router({
  // ...procedures
});

export type AppRouter = typeof appRouter;

createChromeHandler({
  router: appRouter /* 👈 */,
});

3. Add a chromeLink to the client in your content script.

// content.ts
import { createTRPCClient } from '@trpc/client';
import { chromeLink } from 'trpc-chrome/link';

import type { AppRouter } from './background';

const port = chrome.runtime.connect();
export const chromeClient = createTRPCProxyClient<AppRouter>({
  links: [/* 👉 */ chromeLink({ port })],
});

4. (extra) If you have an injected window script, hook it up too!.

// inpage.ts
import { createTRPCClient } from '@trpc/client';
import { windowLink } from 'trpc-chrome/link';

import type { AppRouter } from './background';

export const windowClient = createTRPCProxyClient<AppRouter>({
  links: [/* 👉 */ windowLink({ window })],
});

// content.ts
import { relay } from 'trpc-chrome/relay';

const port = chrome.runtime.connect();
relay(port, window);

Requirements

Peer dependencies:

• tRPC Server v10 (@trpc/server) must be installed.
• tRPC Client v10 (@trpc/client) must be installed.

Example

Please see full example here.

For advanced use-cases, please find examples in our complete test suite.

Types

ChromeLinkOptions

Please see full typings here.

WindowLinkOptions

Please see full typings here.

CreateChromeHandlerOptions

Please see full typings here.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

James Berry - Follow me on Twitter @jlalmes 💙