API Reference

@univerjs/rpc

Browser RPC layer for Univer main-thread and worker communication.

TypeScript
import type { IUniverRPCMainThreadConfig } from '@univerjs/rpc'import { UniverRPCMainThreadPlugin } from '@univerjs/rpc'const config: IUniverRPCMainThreadConfig = {  workerURL: new URL('./worker.js', import.meta.url),}univer.registerPlugin(UniverRPCMainThreadPlugin, config)

workerURL is required when the main-thread plugin starts. Build the following worker entry separately and point workerURL to its output.

TypeScript
import { UniverRPCWorkerThreadPlugin } from '@univerjs/rpc'univer.registerPlugin(UniverRPCWorkerThreadPlugin)

IUniverRPCMainThreadConfig

TypeScript
export interface IUniverRPCMainThreadConfig {  workerURL?: string | URL | Worker}

IUniverRPCWorkerThreadConfig

TypeScript
export interface IUniverRPCWorkerThreadConfig {}

How is this guide?

© 2026 DreamNum Co., Ltd.