Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/earthstar/src/formats/format_es5.ts>DocInputEs5

Earthstar is a tool for private, undiscoverable, offline-first networks.
earthstar-project/earthstar
Go to Latest
interface DocInputEs5
implements DocInputBase<"es.5">
import { type DocInputEs5 } from "https://deno.land/x/earthstar@v10.0.0-alpha.4/src/formats/format_es5.ts";

A partial es.5 doc that is about to get written. The rest of the properties will be computed automatically.

Properties

format: "es.5"

The format the document adheres to, e.g. es.5

path: Path
optional
text: string

Can be left blank if there is a previous version of the document with an attachment.

optional
attachment: Uint8Array | ReadableStream<Uint8Array>

Data as Uint8Array or ReadableStream, to be used as document's associated attachment.

optional
timestamp: number

A UNIX timestamp in microseconds indicating when the document was written. Determined automatically if omitted.

optional
deleteAfter: number | null

A UNIX timestamp in microseconds indicating when the document should be deleted by.