Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/earthstar/src/syncer/partner_web_server.ts>PartnerWebServer

Earthstar is a tool for private, undiscoverable, offline-first networks.
Go to Latest
class PartnerWebServer
implements ISyncPartner<undefined>
import { PartnerWebServer } from "https://deno.land/x/earthstar@v10.0.0-alpha.4/src/syncer/partner_web_server.ts";

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>