Skip to main content
The Deno 2 Release Candidate is here
Learn more
Module

x/earthstar/mod.browser.ts>Replica#getEventStream

Earthstar is a tool for private, undiscoverable, offline-first networks.
earthstar-project/earthstar
Go to Latest
method Replica.prototype.getEventStream
Re-export
import { Replica } from "https://deno.land/x/earthstar@v10.0.0-alpha.2/mod.browser.ts";

Returns a readable stream of replica events, such as new ingestions, document expirations, or the replica preparing to close.

Parameters

optional
channel: OrCh<ReplicaEvent<DocBase<string>>["kind"]> = [UNSUPPORTED]
  • An optional string representing a channel of events to be subscribed to. Defaults to return all events.