ClientSettings | /src/util/client_settings.ts | earthstar@v10.0.0-beta.6

Module

x/earthstar/src/util/client_settings.ts>ClientSettings#getPeer

Earthstar is a tool for private, undiscoverable, offline-first networks.

earthstar-project/earthstar

Go to Latest

attachment_stream_info.ts

ConnectionRefusedError

ReplicaCacheIsClosedError

method ClientSettings.prototype.getPeer

import { ClientSettings } from "https://deno.land/x/earthstar@v10.0.0-beta.6/src/util/client_settings.ts";

getPeer(unnamed 0: { sync: "once" | "continuous" | false; onCreateReplica: (addr: ShareAddress, secret?: string) => Replica; }): { peer: Peer; unsubscribeFromSettings: () => void; }

Get a new Peer preconfigured with shares, secrets, and syncers derived from these settings.

When settings are updated, the peer's replicas and syncers will be updated too.

Parameters

unnamed 0: { sync: "once" | "continuous" | false; onCreateReplica: (addr: ShareAddress, secret?: string) => Replica; }

Returns

{ peer: Peer; unsubscribeFromSettings: () => void; }