Skip to content

Commit af6cc54

Browse files
authored
v1.0.0 (#5)
1 parent 6b3ba95 commit af6cc54

File tree

4 files changed

+2367
-2354
lines changed

4 files changed

+2367
-2354
lines changed

README.md

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -26,39 +26,50 @@ npm install trpc-chrome
2626
yarn add trpc-chrome
2727
```
2828

29-
**2. Add a `chromeLink` to the client in your content script.**
29+
**2. Add `createChromeHandler` in your background script.**
3030

3131
```typescript
32-
// content.ts
33-
import { createTRPCClient } from '@trpc/client';
34-
import { chromeLink } from 'trpc-chrome/link';
32+
// background.ts
33+
import { initTRPC } from '@trpc/server';
34+
import { createChromeHandler } from 'trpc-chrome/adapter';
3535

36-
import type { AppRouter } from './appRouter';
36+
const t = initTRPC.create({
37+
isServer: false,
38+
allowOutsideOfServer: true,
39+
});
3740

38-
const port = chrome.runtime.connect(chrome.runtime.id);
41+
const appRouter = t.router({
42+
// ...procedures
43+
});
3944

40-
export const chromeClient = createTRPCClient<AppRouter>({
41-
links: [/* 👉 */ chromeLink({ port })],
45+
export type AppRouter = typeof appRouter;
46+
47+
createChromeHandler({
48+
router: appRouter /* 👈 */,
4249
});
4350
```
4451

45-
**3. Add `createChromeHandler` in your background script.**
52+
**3. Add a `chromeLink` to the client in your content script.**
4653

4754
```typescript
48-
// background.ts
49-
import { createChromeHandler } from 'trpc-chrome/adapter';
55+
// content.ts
56+
import { createTRPCClient } from '@trpc/client';
57+
import { chromeLink } from 'trpc-chrome/link';
5058

51-
import { appRouter } from './appRouter';
59+
import type { AppRouter } from './background';
5260

53-
createChromeHandler({ router: appRouter /* 👈 */ });
61+
const port = chrome.runtime.connect();
62+
export const chromeClient = createTRPCClient<AppRouter>({
63+
links: [/* 👉 */ chromeLink({ port })],
64+
});
5465
```
5566

5667
## Requirements
5768

5869
Peer dependencies:
5970

60-
- [`tRPC`](https://github.com/trpc/trpc) Server v10 (`@trpc/server@next`) must be installed.
61-
- [`tRPC`](https://github.com/trpc/trpc) Client v10 (`@trpc/client@next`) must be installed.
71+
- [`tRPC`](https://github.com/trpc/trpc) Server v10 (`@trpc/server`) must be installed.
72+
- [`tRPC`](https://github.com/trpc/trpc) Client v10 (`@trpc/client`) must be installed.
6273

6374
## Example
6475

examples/with-plasmo/package.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@
88
"build": "plasmo build"
99
},
1010
"dependencies": {
11-
"@trpc/client": "^10.0.0-rc.7",
12-
"@trpc/server": "^10.0.0-rc.7",
13-
"plasmo": "^0.59.0-alpha.1",
11+
"@trpc/client": "^10.3.0",
12+
"@trpc/server": "^10.3.0",
13+
"plasmo": "^0.59.1",
1414
"react": "^18.2.0",
1515
"react-dom": "^18.2.0",
1616
"zod": "^3.19.1"
1717
},
1818
"devDependencies": {
19-
"@types/chrome": "^0.0.200",
19+
"@types/chrome": "^0.0.203",
2020
"@types/node": "^18.11.9",
2121
"@types/react": "^18.0.25",
22-
"@types/react-dom": "^18.0.8",
23-
"typescript": "^4.8.4"
22+
"@types/react-dom": "^18.0.9",
23+
"typescript": "^4.9.3"
2424
},
2525
"manifest": {
2626
"host_permissions": [

0 commit comments

Comments
 (0)