@graphty/graphty-element / index / NotesDocument

Interface: NotesDocument

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

A session's notes as a saved graphty-notes member, version 1 (design/documents/notes.md). A bare member is also a valid .graphty.json file.

Properties

description?

readonly optional description?: string

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

At most 65,536 characters.

---

extensions?

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

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

Data for other software, under reverse-domain keys.

---

kind

readonly kind: "graphty-notes"

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

Always "graphty-notes".

---

name?

readonly optional name?: string

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

At most 1,024 characters.

---

notes

readonly notes: readonly Note[]

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

Oldest first: by time, then by id. At most 10,000.

---

version

readonly version: 1

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

Always 1.