moderator-toolbox-nxg-for-reddit / util/wiki/schemas/subredditnotes/schema

util/wiki/schemas/subredditnotes/schema¶

Interfaces¶

SubredditNoteIndex¶

Defined in: extension/data/util/wiki/schemas/subredditnotes/schema.ts:29

Top-level structure of the note index wiki page (schema v2).

Properties¶

authors¶

authors: string[]

Defined in: extension/data/util/wiki/schemas/subredditnotes/schema.ts:35

Sorted unique author list, recomputed on every save.

notes¶

notes: SubredditNoteMeta[]

Defined in: extension/data/util/wiki/schemas/subredditnotes/schema.ts:31

tags¶

tags: string[]

Defined in: extension/data/util/wiki/schemas/subredditnotes/schema.ts:33

Sorted unique tag list, recomputed on every save so filters don’t rescan notes.

version¶

version: number

Defined in: extension/data/util/wiki/schemas/subredditnotes/schema.ts:30

SubredditNoteIndexV1¶

Defined in: extension/data/util/wiki/schemas/subredditnotes/schema.ts:39

The legacy (v1) index shape written to the old notes/index page: notes only, no aggregates.

Properties¶

notes¶

notes: SubredditNoteMeta[]

Defined in: extension/data/util/wiki/schemas/subredditnotes/schema.ts:41

version¶

version: number

Defined in: extension/data/util/wiki/schemas/subredditnotes/schema.ts:40

SubredditNoteMeta¶

Defined in: extension/data/util/wiki/schemas/subredditnotes/schema.ts:17

Metadata record stored in the note index for each note.

Properties¶

archived¶

archived: boolean

Defined in: extension/data/util/wiki/schemas/subredditnotes/schema.ts:22

author?¶

optional author?: string

Defined in: extension/data/util/wiki/schemas/subredditnotes/schema.ts:25

Reddit username of the mod who created this note. Absent on notes migrated from older formats.

createdAt¶

createdAt: number

Defined in: extension/data/util/wiki/schemas/subredditnotes/schema.ts:20

slug¶

slug: string

Defined in: extension/data/util/wiki/schemas/subredditnotes/schema.ts:18

tags¶

tags: string[]

Defined in: extension/data/util/wiki/schemas/subredditnotes/schema.ts:23

title¶

title: string

Defined in: extension/data/util/wiki/schemas/subredditnotes/schema.ts:19

updatedAt¶

updatedAt: number

Defined in: extension/data/util/wiki/schemas/subredditnotes/schema.ts:21

Type Aliases¶

SubredditNoteSort¶

SubredditNoteSort = "title" | "updated"

Defined in: extension/data/util/wiki/schemas/subredditnotes/schema.ts:45

Sort order for the note list.

Variables¶

subredditNotesIndexPage¶

const subredditNotesIndexPage: "notes/index" = 'notes/index'

Defined in: extension/data/util/wiki/schemas/subredditnotes/schema.ts:4

Wiki page name for the note index.

subredditNotesIndexVersion¶

const subredditNotesIndexVersion: 2 = 2

Defined in: extension/data/util/wiki/schemas/subredditnotes/schema.ts:7

Current schema version written to every NXG index save.

subredditNotesLegacyIndexVersion¶

const subredditNotesLegacyIndexVersion: 1 = 1

Defined in: extension/data/util/wiki/schemas/subredditnotes/schema.ts:14

Schema version written to the legacy notes/index page, which older toolbox builds read. v1 carries only the notes array; the v2 aggregate fields are stripped on the way out (see encodeLegacyIndex).