Skip to main content
Module

x/earthstar_replica_server/deps.ts>Earthstar.PartnerWebClient

An always-online Earthstar peer for your shares.
Latest
class Earthstar.PartnerWebClient
import { Earthstar } from "https://deno.land/x/earthstar_replica_server@4.0.0-beta.1/deps.ts";
const { PartnerWebClient } = Earthstar;

A syncing partner created from an inbound HTTP connection (i.e. a web client).

Works everywhere, but is really meant for servers running on Deno and Node.

Constructors

new
PartnerWebClient(unnamed 0: SyncerDriverWebServerOpts)

Type Parameters

IncomingTransferSourceType extends WebSocket

Properties

private
incomingQueue: AsyncQueue<SyncerEvent>
private
socket: WebSocket
private
socketIsReady
concurrentTransfers: number
payloadThreshold: number
rangeDivision: number
syncAppetite: SyncAppetite

Methods

closeConnection(): Promise<void>
getEvents(): AsyncIterable<SyncerEvent>
handleTransferRequest(socket: IncomingTransferSourceType, kind: "upload" | "download"): Promise<ReadableStream<Uint8Array> | WritableStream<Uint8Array> | undefined>
sendEvent(event: SyncerEvent): Promise<void>