Skip to main content

ODCheckerStorage class

under construction

We are still working the API Reference! This page might be incomplete or doesn't contain all details!

Overview​

This is an Open Ticket checker storage.

It stores temporary data to share between config checkers! (e.g. The messages.json needs to access the "id" from options.json)

You can use this class when you create your own config checker implementation! (not required for using the built-in config checker)

View Source

Properties​

Methods​

Other​

Properties​

storage array ➜ {key:string, source:api.ODId, value:any}[]​

This is the array that stores all the data. ❌ (don't edit unless really needed!)

View Source

Methods​

constructor() function ➜ api.ODCheckerStorage​

(no description)

View Source

delete() function ➜ boolean​

Delete data from the database (source => id of ODChecker)

View Parameters (2)
  • source: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.
  • key: string ➜ string - Parameter Description Lorem Ipsum.

View Source

get() function ➜ any​

Get data from the database (source => id of ODChecker)

View Parameters (2)
  • source: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.
  • key: string ➜ string - Parameter Description Lorem Ipsum.

View Source

reset() function ➜ void​

Reset the entire database

View Source

set() function ➜ boolean​

Add data to the database (source => id of ODChecker). This function also overwrites existing data!

View Parameters (3)
  • source: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.
  • key: string ➜ string - Parameter Description Lorem Ipsum.
  • value: type ➜ any - Parameter Description Lorem Ipsum.

View Source

Defaults​

under construction

We're still working on this part of the documentation!

Examples​

under construction

We're still working on this part of the documentation!