Root definitions

CacheConfig

Permalink

Properties

authorTTL

number ∪ boolean

Amount of time, in seconds, author activity history (Comments/Submission) should be cached

  • If 0 or true will cache indefinitely (not recommended)

  • If false will not cache

  • ENV => AUTHOR_TTL

  • ARG => --authorTTL <sec>

Default: 60
commentTTL

number ∪ boolean

Amount of time, in seconds, a comment should be cached

  • If 0 or true will cache indefinitely (not recommended)
  • If false will not cache
Default: 60
filterCriteriaTTL

number ∪ boolean

Amount of time, in seconds, to cache filter criteria results (authorIs and itemIs results)

This is especially useful if when polling high-volume comments and your checks rely on author/item filters

  • If 0 or true will cache indefinitely (not recommended)
  • If false will not cache
Default: 60
modNotesTTL

number ∪ boolean

Amount of time, in seconds, Mod Notes should be cached

  • If 0 or true will cache indefinitely (not recommended)
  • If false will not cache
Default: 60
provider

anyOf [CacheOptions, string]

The cache provider and, optionally, a custom configuration for that provider

If not present or null provider will be memory.

To specify another provider but use its default configuration set this property to a string of one of the available providers: memory, redis, or none

selfTTL

number ∪ boolean

Amount of time, in seconds, an Activity that the bot has acted on or created will be ignored if found during polling

This is useful to prevent the bot from checking Activities it just worked on or a product of the checks. Examples:

  • Ignore comments created through an Action
  • Ignore Activity polled from modqueue that the bot just reported

This value should be at least as long as the longest polling interval for modqueue/newComm

  • If 0 or true will cache indefinitely (not recommended)
  • If false will not cache
Default: 50
submissionTTL

number ∪ boolean

Amount of time, in seconds, a submission should be cached

  • If 0 or true will cache indefinitely (not recommended)
  • If false will not cache
Default: 60
subredditTTL

number ∪ boolean

Amount of time, in seconds, a subreddit (attributes) should be cached

  • If 0 or true will cache indefinitely (not recommended)
  • If false will not cache
Default: 600
userNotesTTL

number ∪ boolean

Amount of time, in seconds, Toolbox User Notes should be cached

  • If 0 or true will cache indefinitely (not recommended)
  • If false will not cache
Default: 300
wikiTTL

number ∪ boolean

Amount of time, in seconds, wiki content pages should be cached

  • If 0 or true will cache indefinitely (not recommended)
  • If false will not cache
Default: 300
Loading...

Editor and Validator