moderator-toolbox-nxg-for-reddit / modules/queue_overlay/schema
modules/queue_overlay/schema¶
Interfaces¶
QueueOverlayHandle¶
Defined in: extension/data/modules/queue_overlay/schema.ts:13
Imperative handle returned by showQueueOverlay for controlling a live overlay instance.
Properties¶
setType¶
setType: (
type,options?) =>void
Defined in: extension/data/modules/queue_overlay/schema.ts:20
Switches the active queue type, optionally scoping to a specific subreddit.
Parameters¶
type¶
The queue tab to activate.
options?¶
overwrite?¶
boolean
When true, forces a reload even if the tab was already initialized.
subreddit?¶
string
When provided, reloads the tab scoped to this subreddit.
Returns¶
void
Type Aliases¶
QueueBaseUrls¶
QueueBaseUrls =
Record<QueueType, {subreddits:string; }>
Defined in: extension/data/modules/queue_overlay/schema.ts:7
Maps each queue type to the subreddit multi-string used to build its default URL.
QueueType¶
QueueType =
"modqueue"|"unmoderated"|"reports"|"spam"|"edited"
Defined in: extension/data/modules/queue_overlay/schema.ts:4
The five Reddit mod-queue types surfaced by the overlay.