Skip to main content
Module

x/earthstar/mod.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-alpha.3/mod.ts";

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

Constructors

new
PartnerLocal(
peer: IPeer,
peerSelf: IPeer,
mode: SyncerMode,
)

Type Parameters

FormatsType
IncomingTransferSourceType extends undefined

Properties

private
incomingEventBus: BlockingBus<SyncerEvent>
private
outgoingEventBus: BlockingBus<SyncerEvent>
private
partnerPeer: IPeer
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>