@graphty/graphty-element / index / Note

Interface: Note

Defined in: graphty-element/src/session/notes/types.ts:72

One note. Frozen; get and list return the same object until the note changes. A field with no value is absent. A record holds only what is saved with the note, so it is also the saved form.

Properties

author?

readonly optional author?: string

Defined in: graphty-element/src/session/notes/types.ts:84

From the project's author setting, when one was set. A claim, never a verified identity.

---

cites?

readonly optional cites?: readonly NoteCite[]

Defined in: graphty-element/src/session/notes/types.ts:88

Results the claim rests on.

---

done?

readonly optional done?: string

Defined in: graphty-element/src/session/notes/types.ts:95

When it was marked done, as Date.prototype.toISOString() writes it; stamped by graphty-element. Absent: not done. Set and cleared with update(id, { done }).

---

edited?

readonly optional edited?: string

Defined in: graphty-element/src/session/notes/types.ts:86

When it last changed; stamped by graphty-element.

---

extensions?

readonly optional extensions?: Readonly<Record<string, unknown>>

Defined in: graphty-element/src/session/notes/types.ts:90

Other applications' data, under reverse-domain keys; kept and never read.

---

id

readonly id: string

Defined in: graphty-element/src/session/notes/types.ts:74

Made by graphty-element.

---

mediaType?

readonly optional mediaType?: string

Defined in: graphty-element/src/session/notes/types.ts:82

How the writer meant the text to be read (text/markdown); stored, never acted on.

---

targets

readonly targets: readonly NoteTarget[]

Defined in: graphty-element/src/session/notes/types.ts:78

What it is about: one to 64.

---

text

readonly text: string

Defined in: graphty-element/src/session/notes/types.ts:80

Plain text, stored exactly as given; never blank, at most 65,536 characters.

---

time

readonly time: string

Defined in: graphty-element/src/session/notes/types.ts:76

When it was written, as Date.prototype.toISOString() writes it; stamped by graphty-element.