OptionaljsonString: stringReturns all usernote types.
Returns the usernote type matching the given key. Useful for looking up
display information for a usernote from Usernote.noteType.
const toolbox = new ToolboxClient(reddit);
const subreddit = 'mildlyinteresting';
// Acquire a note somehow
const usernotes = toolbox.getUsernotes(subreddit);
const note = usernotes.get('eritbh')[0];
// Look up information about the type of this note
const subConfig = toolbox.getConfig(subreddit);
const {color, text} = subConfig.getNoteType(note.noteType);
Serializes the subreddit config data for writing back to the wiki. This
method returns an object; you probably want toString
instead.
Object which can be serialized to JSON and written as the
contents of the toolbox wiki page
Stringifies the subreddit config data for writing back to the wiki.
Optionalindent: string | numberPassed as the third argument of JSON.stringify. Useful
for debugging; however, because wiki space is limited, never provide this
parameter when actually saving config to the wiki.
JSON string which can be saved as the contents of the toolbox
wiki page
A class that interfaces with the raw contents of a subreddit's
toolboxwiki page, automatically handling schema checks and providing methods to read and modify subreddit configuration.