API Reference Electric Client v#0.10.2

Copy Markdown View Source

Modules

An Elixir client for ElectricSQL.

Placeholder Electric.Client.Authenticator implementation that doesn't add any authentication params or headers to the Request.

LRU cache for tracking expired shape handles.

Client Electric.Client.Fetch implementation for HTTP requests to an external Electric API server.

Coaleses requests so that multiple client instances making the same (potentially long-polling) request will all use the same request process.

Represents a move-in event from the server.

Represents a move-out event from the server.

Emitted by the synchronisation stream before terminating early. If passed as an option to Client.stream/3 allows for resuming a shape stream at the given point.

Allows for mocking stream messages.

Represents an offset in the synchronisation stream from Electric.

Poll-based API for fetching shape changes.

Struct for defining a shape.

Generate canonical shape keys for cache lookup.

State for polling a shape.

Manages tag tracking for move-out support in Electric shapes.

A behaviour for mapping the value fields of Message.ChangeMessage messages from the shape stream.