Skip to main content
Module

x/earthstar/mod.ts>PartnerWebClient

Earthstar is a tool for private, undiscoverable, offline-first networks.
earthstar-project/earthstar
Go to Latest
class PartnerWebClient
implements ISyncPartner<undefined>
Re-export
import { PartnerWebClient } from "https://deno.land/x/earthstar@v10.0.0-alpha.2/mod.ts";

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

Constructors

new
PartnerWebClient(opts: SyncerDriverWebClientOpts)

Type Parameters

IncomingTransferSourceType extends undefined

Properties

private
isSecure: boolean
private
wsUrl: string
concurrentTransfers: number

Methods

getDownload(opts: GetTransferOpts): Promise<ReadableStream<Uint8Array> | undefined>
handleTransferRequest(_source: IncomingTransferSourceType, _kind: "upload" | "download"): Promise<ReadableStream<Uint8Array> | WritableStream<Uint8Array> | undefined>
handleUploadRequest(opts: GetTransferOpts): Promise<WritableStream<Uint8Array> | undefined>