Research
Security News
Quasar RAT Disguised as an npm Package for Detecting Vulnerabilities in Ethereum Smart Contracts
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
@electric-sql/client
Advanced tools
Postgres everywhere - your data, in sync, wherever you need it.
Real-time Postgres sync for modern apps.
Electric provides an HTTP interface to Postgres to enable a massive number of clients to query and get real-time updates to subsets of the database, called Shapes. In this way, Electric turns Postgres into a real-time database.
The TypeScript client helps ease reading Shapes from the HTTP API in the browser and other JavaScript environments, such as edge functions and server-side Node/Bun/Deno applications. It supports both fine-grained and coarse-grained reactivity patterns — you can subscribe to see every row that changes, or you can just subscribe to get the whole shape whenever it changes.
The client is published on NPM as @electric-sql/client
:
npm i @electric-sql/client
The client exports a ShapeStream
class for getting updates to shapes on a row-by-row basis as well as a Shape
class for getting updates to the entire shape.
ShapeStream
import { ShapeStream } from '@electric-sql/client'
// Passes subscribers rows as they're inserted, updated, or deleted
const stream = new ShapeStream({
url: `${BASE_URL}/v1/shape`,
params: {
table: `foo`
}
})
// You can also add custom headers and URL parameters
const streamWithParams = new ShapeStream({
url: `${BASE_URL}/v1/shape`,
headers: {
'Authorization': 'Bearer token'
},
params: {
table: `foo`,
'custom-param': 'value'
}
})
stream.subscribe(messages => {
// messages is an array with one or more row updates
// and the stream will wait for all subscribers to process them
// before proceeding
})
Shape
import { ShapeStream, Shape } from '@electric-sql/client'
const stream = new ShapeStream({
url: `${BASE_URL}/v1/shape`,
params: {
table: `foo`
}
})
const shape = new Shape(stream)
// Returns promise that resolves with the latest shape data once it's fully loaded
await shape.rows
// passes subscribers shape data when the shape updates
shape.subscribe(({ rows }) => {
// rows is an array of the latest value of each row in a shape.
}
The ShapeStream provides two ways to handle errors:
onError
handler:const stream = new ShapeStream({
url: `${BASE_URL}/v1/shape`,
params: {
table: `foo`
},
onError: (error) => {
// Handle all stream errors here
console.error('Stream error:', error)
}
})
If no onError
handler is provided, the ShapeStream will throw errors that occur during streaming.
stream.subscribe(
(messages) => {
// Handle messages
},
(error) => {
// Handle errors for this specific subscription
console.error('Subscription error:', error)
}
)
Common error types include:
MissingShapeUrlError
: Missing required URL parameterInvalidSignalError
: Invalid AbortSignal instanceReservedParamError
: Using reserved parameter namesRuntime errors:
FetchError
: HTTP errors during shape fetchingFetchBackoffAbortError
: Fetch aborted using AbortSignalMissingShapeHandleError
: Missing required shape handleParserNullValueError
: Parser encountered NULL value in a column that doesn't allow NULL valuesSee the typescript client docs on the website for more details on error handling.
And in general, see the docs website and examples folder for more information.
Install the pnpm workspace at the repo root:
pnpm install
Build the package:
cd packages/typescript-client
pnpm build
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
FAQs
Postgres everywhere - your data, in sync, wherever you need it.
The npm package @electric-sql/client receives a total of 20,286 weekly downloads. As such, @electric-sql/client popularity was classified as popular.
We found that @electric-sql/client demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.