Skip to main content

ODChecker 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 config checker.

It checks a specific config file for invalid/missing configurations. This data can then be used to show to the user what's wrong! You can check for example if a string is longer/shorter than a certain amount of characters & more!

You can use this class when you create your own custom config file & you want to check it for syntax errors.

View Source

Properties​

Methods​

Other​

Properties​

config class ➜ api.ODConfig​

The config file that needs to be checked

View Source

inherited id class ➜ api.ODId​

The id of this data.

View Source

messages array ➜ api.ODCheckerMessage[]​

Temporary storage for all error messages from the check() method (not recommended to use)

View Source

priority number ➜ number​

The higher the priority, the faster it gets checked!

View Source

quit boolean ➜ boolean​

Temporary storage for the quit status from the check() method (not recommended to use)

View Source

storage class ➜ api.ODCheckerStorage​

The storage of this checker (reference for ODCheckerManager.storage)

View Source

structure class ➜ api.ODCheckerStructure​

The structure of the config file

View Source

Methods​

constructor() function ➜ api.ODChecker​

(no description)

View Parameters (5)

View Source

inherited protected _change() function ➜ void​

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

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

check() function ➜ api.ODCheckerResult​

Run this checker. Returns all errors

View Source

createMessage() function ➜ void​

A shortcut to create a warning, info or error message

View Parameters (8)
  • id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.
  • type: type ➜ "info"|"warning"|"error" - Parameter Description Lorem Ipsum.
  • message: string ➜ string - Parameter Description Lorem Ipsum.
  • locationTrace: type ➜ api.ODCheckerLocationTrace - Parameter Description Lorem Ipsum.
  • docs: type ➜ null|string - Parameter Description Lorem Ipsum.
  • translationParams: array ➜ string[] - Parameter Description Lorem Ipsum.
  • locationId: class ➜ api.ODId - Parameter Description Lorem Ipsum.
  • locationDocs: type ➜ null|string - Parameter Description Lorem Ipsum.

View Source

locationTraceDeref() function ➜ api.ODCheckerLocationTrace​

De-reference the locationTrace array. Use this before adding a value to the array

View Parameters (1)

View Source

locationTraceToString() function ➜ string​

Create a string from the location trace (path)

View Parameters (1)

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!