electron-trpc - GitLite

KO | EN

gitlite — search

#javascript #python #react #ai #typescript #golang #deep-learning #awesome #awesome-list #vue #security #mcp #ios #open-source

electron-trpc

(★ 401)

Build type-safe Electron inter-process communication using tRPC

파일 탐색기

최종 버전 다운로드 (.zip)

- config.json
- README.md
- - lint.yml
  - release.yml
  - test.yml
  - www.yml
- - CHANGELOG.md
  - index.e2e.ts
  - index.html
  - package.json
  - tsconfig.json
  - vite.config.ts
- - CHANGELOG.md
  - index.html
  - package.json
  - tsconfig.json
  - vite.config.ts
- - CHANGELOG.md
  - dts-bundle-generator.config.ts
  - package.json
  - tsconfig.json
  - vitest.config.ts
- - env.d.ts
- astro.config.mjs
- package.json
- tsconfig.json
- wrangler.toml
.envrc
.gitignore
.node_version
.npmrc
.prettierignore
.prettierrc.js
CONTRIBUTING.md
LICENSE
package.json
playwright.config.ts
pnpm-lock.yaml
pnpm-workspace.yaml
README.md
renovate.json
shell.nix

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/jsonnull/electron-trpc

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd electron-trpc

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

pnpm add electron-trpc

이 명령어를 터미널에 그대로 입력해 실행하세요.

yarn add electron-trpc

이 명령어를 터미널에 그대로 입력해 실행하세요.

npm install --save electron-trpc

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

<img alt="NPM" src="https://img.shields.io/npm/v/electron-trpc"/>

이 명령어를 터미널에 그대로 입력해 실행하세요.

<img alt="MIT" src="https://img.shields.io/npm/l/electron-trpc"/>

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# electron-trpc

<p>
  <a href="https://www.npmjs.com/package/electron-trpc">
    <img alt="NPM" src="https://img.shields.io/npm/v/electron-trpc"/>
  </a>
  <a href="https://codecov.io/gh/jsonnull/electron-trpc"> 
  <img src="https://codecov.io/gh/jsonnull/electron-trpc/branch/main/graph/badge.svg?token=DU33O0D9LZ"/> 
  </a>
  <span>
    <img alt="MIT" src="https://img.shields.io/npm/l/electron-trpc"/>
  </span>
</p>

<p></p>

**Build IPC for Electron with tRPC**

- Expose APIs from Electron's main process to one or more render processes.
- Build fully type-safe IPC.
- Secure alternative to opening servers on localhost.
- Full support for queries, mutations, and subscriptions.

## Installation

```sh
# Using pnpm
pnpm add electron-trpc

# Using yarn
yarn add electron-trpc

# Using npm
npm install --save electron-trpc
```

## Basic Setup

1. Add your tRPC router to the Electron main process using `createIPCHandler`:

```ts
   import { app } from 'electron';
   import { createIPCHandler } from 'electron-trpc/main';
   import { router } from './api';

app.on('ready', () => {
     const win = new BrowserWindow({
       webPreferences: {
         // Replace this path with the path to your preload file (see next step)
         preload: 'path/to/preload.js',
       },
     });

createIPCHandler({ router, windows: [win] });
   });
   ```

2. Expose the IPC to the render process from the [preload file](https://www.electronjs.org/docs/latest/tutorial/process-model#preload-scripts):

```ts
   import { exposeElectronTRPC } from 'electron-trpc/main';

process.once('loaded', async () => {
     exposeElectronTRPC();
   });
   ```

> Note: `electron-trpc` depends on `contextIsolation` being enabled, which is the default.

3. When creating the client in the render process, use the `ipcLink` (instead of the HTTP or batch HTTP links):

```ts
   import { createTRPCProxyClient } from '@trpc/client';
   import { ipcLink } from 'electron-trpc/renderer';

export const client = createTRPCProxyClient({
     links: [ipcLink()],
   });
   ```

4. Now you can use the client in your render process as you normally would (e.g. using `@trpc/react`).