Skip to main content

ODVersion 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 version.

It has many features like comparing versions & checking if they are compatible.

You can use it in your own plugin, but most of the time you will use it to check the Open Ticket version!

View Source

Properties​

Methods​

Other​

Properties​

inherited id class ➜ api.ODId​

The id of this data.

View Source

primary number ➜ number​

The first number of the version (example: v1.2.3 => 1)

View Source

secondary number ➜ number​

The second number of the version (example: v1.2.3 => 2)

View Source

tertiary number ➜ number​

The third number of the version (example: v1.2.3 => 3)

View Source

Methods​

constructor() function ➜ api.ODVersion​

(no description)

View Parameters (4)
  • id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.
  • primary: number ➜ number - Parameter Description Lorem Ipsum.
  • secondary: number ➜ number - Parameter Description Lorem Ipsum.
  • tertiary: number ➜ number - 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

compare() function ➜ "higher"|"lower"|"equal"​

Compare this version with another version and returns the result: higher, lower or equal

View Parameters (1)
  • comparator: class ➜ api.ODVersion - Parameter Description Lorem Ipsum.

View Source

compatible() function ➜ boolean​

Check if this version is included in the list

View Parameters (1)
  • list: array ➜ api.ODVersion[] - Parameter Description Lorem Ipsum.

View Source

toString() function ➜ string​

Get the version as a string (noprefix:true => with v prefix)

View Parameters (1)
  • noprefix: boolean ➜ boolean - Parameter Description Lorem Ipsum.

View Source

static fromString() function ➜ api.ODVersion​

Get the version from a string (also possible with v prefix)

View Parameters (2)
  • id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.
  • version: 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!