Electric TypeScript Client

The official @electric-sql/client NPM package that wraps the HTTP Sync API with two high-level primitives: ShapeStream (low-level message stream) and Shape (materialized view). Supports SSE, long-polling fallback, custom auth headers, PostgreSQL type parsers, and column mapping utilities for browser and Node.js environments.

API entry from apis.yml

apis.yml Raw ↑
aid: electric-sql:typescript-client
name: Electric TypeScript Client
description: 'The official @electric-sql/client NPM package that wraps the HTTP Sync API with two high-level
  primitives: ShapeStream (low-level message stream) and Shape (materialized view). Supports SSE, long-polling
  fallback, custom auth headers, PostgreSQL type parsers, and column mapping utilities for browser and
  Node.js environments.'
humanURL: https://electric.ax/docs/api/clients/typescript
tags:
- TypeScript
- SDK
- Client Library
- JavaScript
properties:
- type: Documentation
  url: https://electric.ax/docs/api/clients/typescript