Skip to main content
Module

x/earthstar_replica_server/deps.ts>Earthstar.PartnerWebServer

An always-online Earthstar peer for your shares.
Latest
class Earthstar.PartnerWebServer
implements ISyncPartner<undefined>
Re-export
import { Earthstar } from "https://deno.land/x/earthstar_replica_server@4.0.0-beta.1/deps.ts";
const { PartnerWebServer } = Earthstar;

A syncing partner to be used with replica servers reachable via the internet. Works everywhere.

Constructors

new
PartnerWebServer(opts: SyncerDriverWebClientOpts)

Type Parameters

IncomingTransferSourceType extends undefined

Properties

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

Methods

closeConnection(): Promise<void>
getDownload(opts: GetTransferOpts): Promise<ReadableStream<Uint8Array> | undefined>
getEvents(): AsyncIterable<SyncerEvent>
handleTransferRequest(_source: IncomingTransferSourceType, _kind: "upload" | "download"): Promise<
| ReadableStream<Uint8Array>
| WritableStream<Uint8Array>
| undefined
>
sendEvent(event: SyncerEvent): Promise<void>