Skip to main content
Module

x/earthstar/src/entries/node.ts

Storage for private, distributed, offline-first applications.
Latest
import * as earthstar from "https://deno.land/x/earthstar@v10.2.2/src/entries/node.ts";

Earthstar APIs which run in the Node runtime.

Classes

An attachment driver which persists attachments using the local filesystem. Works with Node.

A discovery service for finding peers on the local network, to be used with Peer.discover.

A strorage driver which persists to SQLite. Works in Deno and browsers.

A server extension for populating a server with known shares. Use this to specify which shares you'd like your server to sync with others.

A server extension for exposing the contents of shares, so that you can request documents by their path and have them served over HTTP. Can be used to create wikis, websites, image galleries, and more.

A server extension which reads settings from a specified share, e.g. which shares to host on the server. Settings are modified by other peers syncing with this server.

An extension which enables synchronisation over the web via HTTP.

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

A replica driver which persists data to the filesystem.

An extensible server able to synchronise with other peers.

The core server logic. Combine this with a HTTP framework to create a fully-fledged server.

Variables

A version of the ICryptoDriver interface backed by Chloride. Faster than noble. Works in Node and the browser (with some polyfilling on your part).

A verison of the ICrptoDriver interface backed by native Node crypto functions. Requires a recent version of Node, perhaps 12+? Does not work in the browser.

Interfaces

Implement this interface to create an Earthstar server extension.