ODCheckerManager_Default class
We are still working the API Reference! This page might be incomplete or doesn't contain all details!
Overview
This is a special class that adds type definitions & typescript to the ODCheckerManager class. It doesn't add any extra features!
This default class is made for the global variable opendiscord.checkers!
Methods
Properties
functions class ➜ api.ODCheckerFunctionManager_Default
Final functions are global functions executed just before the report is created.
inherited lastResult type ➜ null|api.ODCheckerResult
A variable containing the last result returned from checkAll()
inherited redirects class ➜ api.ODManagerRedirectHelper
Handle all redirects in this ODManager
renderer class ➜ api.ODCheckerRenderer_Default
The class responsible for rendering the config checker report.
inherited storage class ➜ api.ODCheckerStorage
The global temporary storage shared between all config checkers.
translation class ➜ api.ODCheckerTranslationRegister_Default
The class responsible for translating the config checker report.
Methods
constructor() function ➜ api.ODCheckerManager_Default
(no description)
View Parameters (5)
debug: class ➜api.ODDebugger- Parameter Description Lorem Ipsum.storage: class ➜api.ODCheckerStorage- Parameter Description Lorem Ipsum.renderer: class ➜api.ODCheckerRenderer- Parameter Description Lorem Ipsum.translation: class ➜api.ODCheckerTranslationRegister- Parameter Description Lorem Ipsum.functions: class ➜api.ODCheckerFunctionManager- Parameter Description Lorem Ipsum.
inherited protected _change() function ➜ void
Trigger an onChange() event in the parent ODManager of this class.
inherited add() function ➜ boolean
Add data to the manager. The id will be fetched from the data class! You can optionally select to overwrite existing data!
View Parameters (2)
data: type ➜api.ODChecker|(api.ODChecker[])- Parameter Description Lorem Ipsum.overwrite: boolean ➜boolean- Parameter Description Lorem Ipsum.
inherited changed() function ➜ void
(
SYSTEM ONLY!!) Set the callback executed when a value inside this class changes.
inherited checkAll() function ➜ api.ODCheckerResult
Check all config checkers registered in this manager.
View Parameters (1)
sort: boolean ➜boolean- Parameter Description Lorem Ipsum.
exists() function ➜ boolean
Check if data that matches the ODId exists. Returns a boolean.
View Parameters (1)
id: type ➜keyof api.ODCheckerManagerIds_Default- Parameter Description Lorem Ipsum.
get() function ➜ null|api.ODChecker
Get data that matches the ODId. Returns the found data.
View Parameters (1)
id: type ➜api.ODValidId- Parameter Description Lorem Ipsum.
inherited getAll() function ➜ api.ODChecker[]
Get all data inside this manager
inherited getFiltered() function ➜ api.ODChecker[]
Get all data that matches inside the filter function
View Parameters (1)
predicate: function ➜(value:api.ODChecker, index:number, array:api.ODChecker[]) => unknown- Parameter Description Lorem Ipsum.
inherited getIds() function ➜ api.ODId[]
Get a list of all the ids inside this manager
inherited getLength() function ➜ number
Get the length of the data inside this manager
inherited getRegex() function ➜ api.ODChecker[]
Get all data that matches the regex
View Parameters (1)
regex: type ➜RegExp- Parameter Description Lorem Ipsum.
inherited loopAll() function ➜ Promise
Run an iterator over all data in this manager. This method also supports async-await behaviour!
View Parameters (1)
cb: function ➜(data:api.ODChecker, id:api.ODId) => api.ODPromiseVoid- Parameter Description Lorem Ipsum.
inherited onAdd() function ➜ void
Listen for when data is added to this manager.
View Parameters (1)
callback: type ➜api.ODManagerAddCallback- Parameter Description Lorem Ipsum.
inherited onChange() function ➜ void
Listen for when data is changed in this manager.
View Parameters (1)
callback: type ➜api.ODManagerCallback- Parameter Description Lorem Ipsum.
inherited onRemove() function ➜ void
Listen for when data is removed from this manager.
View Parameters (1)
callback: type ➜api.ODManagerCallback- Parameter Description Lorem Ipsum.
remove() function ➜ null|api.ODChecker
Remove data that matches the ODId. Returns the removed data.
View Parameters (1)
id: type ➜api.ODValidId- Parameter Description Lorem Ipsum.
inherited useDebug() function ➜ void
Use the Open Ticket debugger in this manager for logs
View Parameters (2)
debug: class ➜api.ODDebugger- Parameter Description Lorem Ipsum.debugname: string ➜string- Parameter Description Lorem Ipsum.
Defaults
We're still working on this part of the documentation!
Examples
We're still working on this part of the documentation!