ODCheckerManager 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 manager.

It manages all config checkers in the bot and allows plugins to access config checkers from Open Ticket & other plugins!

You can use this class to get/add a config checker (ODChecker) in your plugin!

View Source

Properties

• functions
• lastResult
• redirects
• renderer
• storage
• translation

Methods

• constructor
• _change
• add
• changed
• checkAll
• exists
• get
• getAll
• getFiltered
• getIds
• getLength
• getRegex
• loopAll
• onAdd
• onChange
• onRemove
• remove
• useDebug

Other

• Open Ticket Defaults
• Plugin Defaults
• Examples

Properties

---

functions class ➜ api.ODCheckerFunctionManager

Final functions are global functions executed just before the report is created.

View Source

---

lastResult type ➜ null|api.ODCheckerResult

A variable containing the last result returned from checkAll()

View Source

---

inherited redirects class ➜ api.ODManagerRedirectHelper

Handle all redirects in this ODManager

View Source

---

renderer class ➜ api.ODCheckerRenderer

The class responsible for rendering the config checker report.

View Source

---

storage class ➜ api.ODCheckerStorage

The global temporary storage shared between all config checkers.

View Source

---

translation class ➜ api.ODCheckerTranslationRegister

The class responsible for translating the config checker report.

View Source

---

Methods

---

constructor() function ➜ api.ODCheckerManager

(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.

View Source

---

inherited protected _change() function ➜ void

Trigger an onChange() event in the parent ODManager of this class.

View Source

---

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.

View Source

---

inherited changed() function ➜ void

(❌ SYSTEM ONLY!!) Set the callback executed when a value inside this class changes.

View Parameters (1)

• callback: type ➜ null|(() => void) - Parameter Description Lorem Ipsum.

View Source

---

checkAll() function ➜ api.ODCheckerResult

Check all config checkers registered in this manager.

View Parameters (1)

• sort: boolean ➜ boolean - Parameter Description Lorem Ipsum.

View Source

---

inherited exists() function ➜ boolean

Check if data that matches the ODId exists. Returns a boolean.

View Parameters (1)

• id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.

View Source

---

inherited 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.

View Source

---

inherited getAll() function ➜ api.ODChecker[]

Get all data inside this manager

View Source

---

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.

View Source

---

inherited getIds() function ➜ api.ODId[]

Get a list of all the ids inside this manager

View Source

---

inherited getLength() function ➜ number

Get the length of the data inside this manager

View Source

---

inherited getRegex() function ➜ api.ODChecker[]

Get all data that matches the regex

View Parameters (1)

• regex: type ➜ RegExp - Parameter Description Lorem Ipsum.

View Source

---

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.

View Source

---

inherited onAdd() function ➜ void

Listen for when data is added to this manager.

View Parameters (1)

• callback: type ➜ api.ODManagerAddCallback - Parameter Description Lorem Ipsum.

View Source

---

inherited onChange() function ➜ void

Listen for when data is changed in this manager.

View Parameters (1)

• callback: type ➜ api.ODManagerCallback - Parameter Description Lorem Ipsum.

View Source

---

inherited onRemove() function ➜ void

Listen for when data is removed from this manager.

View Parameters (1)

• callback: type ➜ api.ODManagerCallback - Parameter Description Lorem Ipsum.

View Source

---

inherited 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.

View Source

---

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.

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!