Socket
Socket
Sign inDemoInstall

trpc-chrome

Package Overview
Dependencies
2
Maintainers
1
Versions
8
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

trpc-chrome


Version published
Maintainers
1
Install size
26.9 kB
Created

Readme

Source

trpc-chrome

trpc-chrome



Chrome extension support for tRPC 🧩

  • Easy communication for web extensions.
  • Typesafe messaging between 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 = createTRPCClient<AppRouter>({
  links: [/* 👉 */ chromeLink({ port })],
});

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.

PropertyTypeDescriptionRequired
portchrome.runtime.PortAn open web extension port between content & background scripts.true
CreateChromeHandlerOptions

Please see full typings here.

PropertyTypeDescriptionRequired
routerRouterYour application tRPC router.true
createContextFunctionPasses contextual (ctx) data to procedure resolvers.false
onErrorFunctionCalled if error occurs inside handler.false

License

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

Contact

James Berry - Follow me on Twitter @jlalmes 💙

Keywords

FAQs

Last updated on 27 Nov 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc