Skip to main content
Home

@mikebryant/earthstar@11.0.0-beta.3+hack5

It is unknown whether this package works with Cloudflare Workers, Node.js, Deno, Bun, Browsers
It is unknown whether this package works with Cloudflare Workers
It is unknown whether this package works with Node.js
It is unknown whether this package works with Deno
It is unknown whether this package works with Bun
It is unknown whether this package works with Browsers
Published
2 years ago (11.0.0-beta.3+hack5)

default

Earthstar is a general purpose distributed data store, designed with the social realities of peer-to-peer computing kept in mind. It is powered by Willow.

T
AuthOpts

Options for constructing an Auth instance.

c
AuthorisationError

Authorisation failed on an attempted document write, cap delegation, etc.

T
Blake3Digest

A BLAKE3 digest created by a Blake3Driver.

T
Blake3Driver

A driver capable of creating Blake3Digest from bytes.

T
CapSelector

A query which selects all capabilities which grant the given parameters.

T
Document

The metadata associated with a Payload.

c
EarthstarError

Generic top-level error class that other Earthstar errors inherit from.

I
Ed25519Driver

A driver capabile of generating ed25199 keypairs and using them to sign and verify data.

T
IdentityKeypair

An identity's tag and its corresponding secret key.

T
IdentityTag

An identity's public key encoded in a more human-friendly form.

f
isErr

Check if any value is a subclass of EarthstarError (return true) or not (return false)

f
notErr

Check if any value is a subclass of EarthstarError (return false) or not (return true)

T
Payload

Provides access to the (possibly partial) data associated with a Document.

T
PeerOpts

Options for configuring a Peer.

T
ReadAuthorisation

A ReadCapability and possibly accompanying SubspaceCapability

I
RuntimeDriver

Instructs Earthstar how to perform ed25519 and BLAKE3 operations on differing runtimes.

c
RuntimeDriverUniversal

A RuntimeDriver with primitives which work on any runtime.

I
ServerExtension

Implement this interface to create an Earthstar server extension.

T
SetEvent

Emitted after an attempt to set a document.

T
ShareKeypair

A share's tag and its corresponding secret key.

T
ShareTag

An share's public key encoded in a more human-friendly form.

I
StorageDriver

Provides a Peer with methods for persisting authorisation data (keypairs, caps), as well as Share data for its Stores.

c
StorageDriverMemory

A StorageDriver for persisting keypairs, caps, entries, and payloads in memory.

c
Store

A store for reading, writing, and querying documents from a corresponding share.

T
StoreDriverOpts

Options for configuring the drivers used by a Store.

c
Syncer

Synchronises different shares known by a Peer.

f
syncInMemory

Sync two Peer instances in the same process using an in-memory transport.

T
SyncInterests

A mapping of ReadAuthorisation to AreaOfInterests permitted by that authorisation.

T
Transport

A transport for exchanging bytes with another peer.

c
ValidationError

Validation failed on a document, share address, author address, etc.

browser

Modules for using Earthstar in browsers, e.g. persisting data to IndexedDB.

c
StorageDriverIndexedDB

A StorageDriver for persisting keypairs, caps, entries, and payloads in IndexedDB.

deno

Modules for using Earthstar on the Deno runtime, e.g. persisting data to the filesystem.

c
ExtensionSyncWebsocket

Extends a server so that it can receive requests to sync over Websockets.

f
getStorageDriverFilesystem
No documentation available
c
RuntimeDriverDeno
No documentation available
c
Server

An extensible Earthstar server able to synchronise with other peers.

T
ServerOpts
No documentation available

New Ticket: Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.