Skip to main content

ODResponderImplementation 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 responder implementation.

It is a basic implementation of the ODWorkerManager used by all ODResponder classes.

This class can't be used stand-alone & needs to be extended from!

View Source

Properties​

Methods​

Other​

Properties​

inherited id class ➜ api.ODId​

The id of this data.

View Source

match type ➜ string|RegExp​

The commandName or customId needs to match this string or regex for this responder to be executed.

View Source

workers class ➜ api.ODWorkerManager​

The manager that has all workers of this implementation

View Source

Methods​

constructor() function ➜ api.ODResponderImplementation​

(no description)

View Parameters (5)
  • id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.
  • match: type ➜ string|RegExp - Parameter Description Lorem Ipsum.
  • callback: type ➜ api.ODWorkerCallback - Parameter Description Lorem Ipsum.
  • priority: number ➜ number - Parameter Description Lorem Ipsum.
  • callbackId: type ➜ api.ODValidId - 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 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

respond() function ➜ Promise​

Execute all workers & return the result.

View Parameters (3)
  • instance: type ➜ Instance - Parameter Description Lorem Ipsum.
  • source: type ➜ Source - Parameter Description Lorem Ipsum.
  • params: type ➜ Params - 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!