Skip to main content
Module

x/earthstar/mod.browser.ts>PartnerLocal

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

A syncing partner to be used with local instances of IPeer. Works everywhere.

Constructors

new
PartnerLocal(
peer: IPeer,
peerSelf: IPeer,
appetite: SyncAppetite,
formats?: FormatsArg<FormatsType>,
)

Type Parameters

FormatsType
IncomingTransferSourceType extends undefined

Properties

private
incomingQueue: AsyncQueue<SyncerEvent>
private
outgoingQueue: AsyncQueue<SyncerEvent>
private
partnerPeer: IPeer
concurrentTransfers: number
partnerSyncer: Syncer<IncomingTransferSourceType, FormatsType>
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
| NotSupportedError
>
handleUploadRequest(_opts: GetTransferOpts): Promise<WritableStream<Uint8Array> | NotSupportedError>
sendEvent(event: SyncerEvent): Promise<void>