Skip to main content

ODDatabase 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 database template. This class doesn't do anything at all, it just gives a template & basic methods for a database. Use ODJsonDatabase instead!

You can use this class if you want to create your own database implementation (e.g. mongodb, mysql,...)!

View Source

Properties​

Methods​

Other​

Properties​

file string ➜ string​

The name of the file with extension.

View Source

inherited id class ➜ api.ODId​

The id of this data.

View Source

path string ➜ string​

The path to the file relative to the main directory.

View Source

Methods​

constructor() function ➜ api.ODDatabase​

(no description)

View Parameters (1)
  • id: 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

delete() function ➜ api.ODOptionalPromise​

Delete a specific category & key in the database

View Parameters (2)
  • category: string ➜ string - Parameter Description Lorem Ipsum.
  • key: string ➜ string - Parameter Description Lorem Ipsum.

View Source

exists() function ➜ api.ODOptionalPromise​

Check if a specific category & key exists in the database

View Parameters (2)
  • category: string ➜ string - Parameter Description Lorem Ipsum.
  • key: string ➜ string - Parameter Description Lorem Ipsum.

View Source

get() function ➜ api.ODOptionalPromise​

Get a specific category & key in the database

View Parameters (2)
  • category: string ➜ string - Parameter Description Lorem Ipsum.
  • key: string ➜ string - Parameter Description Lorem Ipsum.

View Source

getAll() function ➜ api.ODOptionalPromise​

Get all values in the database

View Source

getCategory() function ➜ api.ODOptionalPromise​

Get a specific category in the database

View Parameters (1)
  • category: string ➜ string - Parameter Description Lorem Ipsum.

View Source

init() function ➜ api.ODPromiseVoid​

Init the database.

View Source

set() function ➜ api.ODOptionalPromise​

Add/Overwrite a specific category & key in the database. Returns true when overwritten.

View Parameters (3)
  • category: string ➜ string - Parameter Description Lorem Ipsum.
  • key: string ➜ string - Parameter Description Lorem Ipsum.
  • value: type ➜ api.ODValidJsonType - 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!