moderator-toolbox-nxg-for-reddit / modules/removalreasons/overlayOpener
modules/removalreasons/overlayOpener¶
Functions¶
openRemovalReasonOverlay()¶
openRemovalReasonOverlay(
options):void
Defined in: extension/data/modules/removalreasons/overlayOpener.ts:39
Opens the removal-reasons overlay for a thing. A no-op when the removalreasons module is not active (no opener registered), so callers never need to guard on it.
Parameters¶
options¶
Which thing to remove, and whether to remove it as spam.
Returns¶
void
setRemovalOverlayOpener()¶
setRemovalOverlayOpener(
fn):void
Defined in: extension/data/modules/removalreasons/overlayOpener.ts:30
Registers the live overlay opener (called once when the removalreasons handlers initialize) and cleared on teardown. Injectable so tests and other modules need not import the handlers factory.
Parameters¶
fn¶
Opener | null
The opener, or null to unregister.
Returns¶
void
Interfaces¶
OpenRemovalOverlayOptions¶
Defined in: extension/data/modules/removalreasons/overlayOpener.ts:10
Options accepted by the removal-reasons overlay opener.
Properties¶
isComment¶
isComment:
boolean
Defined in: extension/data/modules/removalreasons/overlayOpener.ts:16
Whether the thing is a comment (vs a post).
spam?¶
optionalspam?:boolean
Defined in: extension/data/modules/removalreasons/overlayOpener.ts:18
Remove as spam (trains the spam filter) rather than a plain removal.
thingID¶
thingID:
string
Defined in: extension/data/modules/removalreasons/overlayOpener.ts:12
Fullname of the thing to remove (t3_.../t1_...).
thingSubreddit¶
thingSubreddit:
string
Defined in: extension/data/modules/removalreasons/overlayOpener.ts:14
Subreddit the thing belongs to (no r/ prefix).