Interface RawSubredditConfig

Raw data stored as JSON on the toolbox wiki page.

Note that while the library supports upgrading older schemas to the current one (via migrateConfigToLatestSchema), this type will only describe the latest known schema version. If you are manually reading data from the wiki without passing it through the migration function, and you read a ver value different than LATEST_KNOWN_CONFIG_SCHEMA, this type will not describe that data.

interface RawSubredditConfig {
    banMacros: { banMessage: string; banNote: string };
    domainTags: RawDomainTag[];
    modMacros: RawModMacro[];
    removalReasons: {
        autoArchive: boolean;
        bantitle: unknown;
        footer: string;
        getfrom: string;
        header: string;
        logreason: string;
        logsub: string;
        logtitle: string;
        pmsubject: string;
        reasons: RawRemovalReason[];
        removalOption: "suggest" | "leave" | "force";
        typeAsSub: boolean;
        typeCommentAsSubreddit: boolean;
        typeLockComment: boolean;
        typeLockThread: boolean;
        typeReply: "reply" | "pm" | "both" | "none";
        typeStickied: boolean;
    };
    usernoteColors: RawUsernoteType[];
    ver: 1;
}

Properties

banMacros domainTags modMacros removalReasons usernoteColors ver

Properties

banMacros

banMacros: { banMessage: string; banNote: string }

Default settings for banning users via the mod button

Type declaration

  • banMessage: string

    The default message sent to banned users

  • banNote: string

    The default mod-only ban note

domainTags

domainTags: RawDomainTag[]

Settings for individual domain tags

modMacros

modMacros: RawModMacro[]

Settings for individual mod macros

removalReasons

removalReasons: {
    autoArchive: boolean;
    bantitle: unknown;
    footer: string;
    getfrom: string;
    header: string;
    logreason: string;
    logsub: string;
    logtitle: string;
    pmsubject: string;
    reasons: RawRemovalReason[];
    removalOption: "suggest" | "leave" | "force";
    typeAsSub: boolean;
    typeCommentAsSubreddit: boolean;
    typeLockComment: boolean;
    typeLockThread: boolean;
    typeReply: "reply" | "pm" | "both" | "none";
    typeStickied: boolean;
}

Settings for removal reasons

Type declaration

  • autoArchive: boolean

    If true and typeAsSub is true, removal reason messages sent as modmail will be automatically archived

  • bantitle: unknown

    Unimplemented - Toolbox itself does nothing with this key

    Deprecated

  • footer: string

    Footer text for removal messages (may include tokens)

  • getfrom: string

    Name of another subreddit to fetch removal reasons from, instead of using the reasons defined in this config, or an empty string for none

  • header: string

    Header text for removal messages (may include tokens)

  • logreason: string

    Reason string for logging sub use (may include tokens)

    Deprecated

    please don't make me support logsubs

  • logsub: string

    Target subreddit for logging sub use, or an empty string for none

    Deprecated

    please don't make me support logsubs

  • logtitle: string

    Title string for logging sub use (may include tokens)

    Deprecated

    please don't make me support logsubs

  • pmsubject: string

    Subject for removal messages in PM/modmail (may include tokens)

  • reasons: RawRemovalReason[]

    The individual removal reasons

  • removalOption: "suggest" | "leave" | "force"

    How subreddit settings for sending removal messages are enforced to moderators. This property impacts how the type* and autoArchive properties are interpreted.

    • suggest - Subreddit settings should be the default every time a reason is being left, but can be changed by moderators in the UI on a case-by-case basis
    • leave - Subreddit settings are ignored and whatever settings the user has configured in Toolbox personal settings are always used
    • force - Subreddit settings are used for all reasons and moderators cannot change them when leaving a removal reason
  • typeAsSub: boolean

    If true, removal messages sent as PMs will be sent through modmail; if false, they will be sent through the acting mod's personal PMs

  • typeCommentAsSubreddit: boolean

    If true, removal messages sent as replies will be made using the fake subreddit_ModTeam account

  • typeLockComment: boolean

    If true, removal messages sent as replies will be locked

  • typeLockThread: boolean

    If true, using a removal reason on a submission will also lock the comments of that submission

  • typeReply: "reply" | "pm" | "both" | "none"

    How removal reason messages are sent by default.

    • reply - Message is sent as a comment reply to the actioned item
    • pm - Message is sent as a private message
    • both - Message is sent both as a reply and as a PM
    • none - No message is sent (only useful for logsub users)
  • typeStickied: boolean

    If true, messages sent as replies will be stickied where possible

usernoteColors

usernoteColors: RawUsernoteType[]

Settings for individual usernote types

ver

ver: 1

The version number of the config schema this data conforms to

Settings

Member Visibility

On This Page

Properties