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:26

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:32

Sorted unique author list, recomputed on every save.

notes¶

notes: SubredditNoteMeta[]

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

tags¶

tags: string[]

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

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:27

SubredditNoteIndexV1¶

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

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:38

version¶

version: number

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

SubredditNoteMeta¶

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

Metadata record stored in the note index for each note.

Properties¶

archived¶

archived: boolean

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

author?¶

optional author?: string

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

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:17

slug¶

slug: string

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

tags¶

tags: string[]

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

title¶

title: string

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

updatedAt¶

updatedAt: number

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

Type Aliases¶

SubredditNoteSort¶

SubredditNoteSort = "title" | "updated"

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

Sort order for the note list.

Variables¶

subredditNotesIndexVersion¶

const subredditNotesIndexVersion: 2 = 2

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

Current schema version written to every NXG index save.

subredditNotesLegacyIndexVersion¶

const subredditNotesLegacyIndexVersion: 1 = 1

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

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).