Skip to main content
Module

x/earthstar/src/entries/universal.ts>DocEs5

Storage for private, distributed, offline-first applications.
earthstar-project/earthstar
Go to Latest
interface DocEs5
implements DocBase<"es.5">
Re-export
import { type DocEs5 } from "https://deno.land/x/earthstar@v10.0.2/src/entries/universal.ts";

Contains data written and signed by an identity.

Properties

format: "es.5"

Which document format the doc adheres to, e.g. es.5.

author: AuthorAddress

The address of the author keypair which wrote this document.

text: string

Text content. If the document has an attachment, this should be a description of that attachment.

textHash: string

Base32 SHA256 hash of this document's text.

optional
deleteAfter: number

When the document should be deleted, as a UNIX timestamp in microseconds.

path: Path

The path this document was written to.

signature: Signature

Used to verify the authorship of the document.

shareSignature: Signature

Used to verify the author knows the share's secret

timestamp: Timestamp

When the document was written, as a UNIX timestamp in microseconds (millionths of a second, e.g. Date.now() * 1000).

share: ShareAddress

The public address of the share this document is from.

optional
attachmentSize: number

The size of the associated attachment in bytes, if any.

optional
attachmentHash: string

The sha256 hash of the associated attachment, if any.

optional
_localIndex: LocalIndex