Skip to main content
Module

x/earthstar/mod.ts>IServerExtension

Earthstar is a tool for private, undiscoverable, offline-first networks.
earthstar-project/earthstar
Go to Latest
interface IServerExtension
Re-export
import { type IServerExtension } from "https://deno.land/x/earthstar@v10.0.0/mod.ts";

Implement this interface to create an Earthstar server extension.

  • register is called once by the server, and this is where you can get a reference to its underlying Earthstar.Peer.
  • handler is called by the server when it is trying to fulfil an external request. If your extension does not interact with user requests you can return Promise.resolve(null).

Methods

register(peer: Peer): Promise<void>
handler(req: Request): Promise<Response | null>