Experimental TypeScript features for ElectricSQL
Install
The client is published on NPM as @electric-sql/experimental:
npm i @electric-sql/experimental
Develop
Install the pnpm workspace at the repo root:
pnpm install
Build the package:
cd packages/typescript-client
pnpm build
Test
In one terminal, start the backend running:
cd ../sync-service
mix deps.get
mix stop_dev && mix compile && mix start_dev && ies -S mix
Then in this folder:
pnpm test
关于 @electric-sql/experimental 的常见问题
@electric-sql/experimental 是什么?
Experimental TypeScript features for ElectricSQL.
如何安装 @electric-sql/experimental?
在项目目录运行 npm install @electric-sql/experimental,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@electric-sql/client(1.5.28)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。
@electric-sql/experimental 支持 TypeScript 吗?
支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。
@electric-sql/experimental 支持 ESM 还是 CommonJS?
同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。
@electric-sql/experimental 可以商用吗?
@electric-sql/experimental 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。
@electric-sql/experimental 的下载量有多少?
根据 npm 官方下载统计,@electric-sql/experimental 在 2026/10/14 – 2026/11/12 这 30 天内被下载 106,673 次,日均约 3,556 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。
@electric-sql/experimental 还在维护吗?
最新版本 6.0.28 发布于 2026/09/09(2 个月前);至今共发布 64 个版本,其中过去 12 个月发布了 39 个;首次发布于 2024/12/10。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。