ODCheckerStructure 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 structure.

This class will check for a single variable in a config file, customise it in the settings! If you want prebuilt checkers (for strings, booleans, numbers, ...), check the other ODCheckerStructure's!

Not recommended to use! It's recommended to extend from another ODConfigCheckerStructure class!

View Source

Properties

• id
• options

Methods

• constructor
• check

Other

• Open Ticket Defaults
• Plugin Defaults
• Examples

Properties

---

id class ➜ api.ODId

The id of this checker structure

View Source

---

options interface ➜ api.ODCheckerStructureOptions

The options for this checker structure

View Source

---

Methods

---

constructor() function ➜ api.ODCheckerStructure

(no description)

View Parameters (2)

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

View Source

---

check() function ➜ boolean

Check a variable if it matches all settings in this checker. This function is automatically executed by Open Ticket!

View Parameters (3)

• checker: class ➜ api.ODChecker - Parameter Description Lorem Ipsum.
• value: type ➜ api.ODValidJsonType - Parameter Description Lorem Ipsum.
• locationTrace: type ➜ api.ODCheckerLocationTrace - 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!