Getiyo-Public/Getiyo-Developer-Documentation
1
0
Fork 0
Code Issues 6 Releases Wiki Activity

Added more documentation

Mees van der Wijk
2026-01-30 14:07:15 +01:00
parent 3e1e1f3819
commit 4bb05b4c8c
3 changed files with 324 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
ModuleServerAPI.md

@@ -168,7 +168,7 @@ api.hasClient(clientId);
Assigns an event to be triggered when a new ModuleClientAPI connects. Assigns an event to be triggered when a new ModuleClientAPI connects.
```javascript ```javascript
api.onNewClient(callback); api.onClientConnects(callback);
``` ```
| Argument | Type | Description | | Argument | Type | Description |
@@ -180,7 +180,7 @@ api.onNewClient(callback);
Assigns an event to be triggered when a new ModuleClientAPI disconnects. Assigns an event to be triggered when a new ModuleClientAPI disconnects.
```javascript ```javascript
api.onNewClient(callback); api.onClientDisconnects(callback);
``` ```
| Argument | Type | Description | | Argument | Type | Description |
@@ -189,18 +189,18 @@ api.onNewClient(callback);
## Properties ## Properties
### onModulePropertyUpdate ### onModulePropertyChange
Register a listener for when a module property updates. The listener will also be triggered on initial module creation and when the server starts up. Register a listener for when a module property changes. The listener will also be triggered on initial module creation and when the server starts up.
```javascript ```javascript
api.onModulePropertyUpdate(propertyId, callback); api.onModulePropertyChange(propertyId, callback);
``` ```
| Argument | Type | Description | | Argument | Type | Description |
| ---------- | ------------------ | ----------------------------------------------- | | ---------- | ------------------------------------------------------- | ----------------------------------------------- |
| propertyId | string | The property ID that the listener will receive. | | propertyId | string | The property ID that the listener will receive. |
| callback | ( value:any ):void | Function that receives the new property value. | | callback | ( property:[Property](./ModuleServerAPIProperty) ):void | Function that receives the new property. |
### getModuleProperties ### getModuleProperties
@@ -224,7 +224,7 @@ api.getModuleProperty(propertyId);
| ---------- | ------ | --------------------------------------- | | ---------- | ------ | --------------------------------------- |
| propertyId | string | The id of the property you want to get. | | propertyId | string | The id of the property you want to get. |
**Returns** [Property](./ModuleServerAPIProperty) _Reference property_ **Returns** [Property](./ModuleServerAPIProperty) _Module property_
### hasModuleProperty ### hasModuleProperty
@@ -240,18 +240,18 @@ api.hasModuleProperty(propertyId);
**Returns** boolean _Has module property_ **Returns** boolean _Has module property_
### onReferencePropertyUpdate ### onReferencePropertyChange
Register a listener for when a reference property updates in a scene change. Register a listener for when a reference property changes.
```javascript ```javascript
api.onReferencePropertyUpdate(propertyId, callback); api.onReferencePropertyChange(propertyId, callback);
``` ```
| Argument | Type | Description | | Argument | Type | Description |
| ---------- | ------------------ | ----------------------------------------------- | | ---------- | ----------------------------------------------------------------------- | ----------------------------------------------- |
| propertyId | string | The property ID that the listener will receive. | | propertyId | string | The property ID that the listener will receive. |
| callback | ( value:any ):void | Function that receives the new property value. | | callback | ( sceneId:string, property:[Property](./ModuleServerAPIProperty) ):void | Function that receives the new property. |
### getReferenceProperties ### getReferenceProperties
@@ -338,6 +338,14 @@ api.getChannelModules();
### hasChannelModules ### hasChannelModules
Check if a module exists within the channel.
```javascript
api.hasChannelModules();
```
**Returns** boolean _Module exists_
## Cues ## Cues
### finishServerCondition ### finishServerCondition
@@ -487,6 +495,8 @@ api.readJSON(scope, filename, callback);
| filename | string | The name of the file. | | filename | string | The name of the file. |
| callback | ( json:any ):void | Function will be called with the JSON once it's loaded. | | callback | ( json:any ):void | Function will be called with the JSON once it's loaded. |
**Returns** Promise\<any> _Loaded JSON data_
### writeJSON ### writeJSON
Write a file as JSON. Write a file as JSON.
@@ -502,6 +512,24 @@ api.writeJSON(scope, filename, json, callback?);
| json | object | The JSON data to write. | | json | object | The JSON data to write. |
| (Optional) callback | function | Function will be called with the JSON was saved. | | (Optional) callback | function | Function will be called with the JSON was saved. |
**Returns** Promise\<boolean> _Write successful_
### readFile
Read a file.
```javascript
api.readJSON(scope, filename, callback);
```
| Argument | Type | Description |
| -------- | --------------------------------------------- | ------------------------------------------------------- |
| scope | 'static' \| 'module' \| 'channel' \| 'static' | The scope of the file. |
| filename | string | The name of the file. |
| callback | ( json:any ):void | Function will be called with the JSON once it's loaded. |
**Returns** Promise\<string> _Loaded data_
### writeFile ### writeFile
Write a file. Write a file.
@@ -518,6 +546,8 @@ api.writeFile(scope, filename, data, options, callback?);
| options | Object \| string | Writing options/mode to use. See [fs.writeFile](https://nodejs.org/api/fs.html#fs_fs_writefile_file_data_options_callback). | | options | Object \| string | Writing options/mode to use. See [fs.writeFile](https://nodejs.org/api/fs.html#fs_fs_writefile_file_data_options_callback). |
| (Optional) callback | function | Function will be called with the JSON was saved. | | (Optional) callback | function | Function will be called with the JSON was saved. |
**Returns** Promise\<boolean> _Write successful_
### fileExists ### fileExists
Check if a file exists. Check if a file exists.
@@ -527,10 +557,28 @@ api.fileExists(scope, filename, callback);
``` ```
| Argument | Type | Description | | Argument | Type | Description |
| -------- | --------------------------------------------- | ---------------------------------------------------------------- | | ------------------- | --------------------------------------------- | ---------------------------------------------------------------- |
| scope | 'static' \| 'module' \| 'channel' \| 'static' | The scope of the file. | | scope | 'static' \| 'module' \| 'channel' \| 'static' | The scope of the file. |
| filename | string | The name of the file. | | filename | string | The name of the file. |
| callback | ( exists:boolean ):void | Function will be called when the file exists check has finished. | | (Optional) callback | ( exists:boolean ):void | Function will be called when the file exists check has finished. |
**Return** Promise\<boolean> _File exists_
### loadDatabase
Load a database into memory. Will create a new one if it does not exist yet.
```javascript
api.loadDatabase(scope, filename, specification);
```
| Argument | Type | Description |
| ------------- | ------------------------------------------------------------------------- | ------------------------------ |
| scope | 'module' \| 'channel' \| 'static' | The scope of the file. |
| filename | string | The name of the file. |
| specification | [DatabaseSpecification](./ModuleServerAPIDatabase#database-specification) | Specification of the database. |
**Return** [Database](./ModuleServerAPIDatabase#) _Database instance_
### addHost ### addHost

200
ModuleServerAPIDatabase.md Normal file

@@ -0,0 +1,200 @@
# ModuleServerAPI Database
The ModuleServerAPI allows loading sqlite3 database into memory using it's own wrapper.
## Database Specification
To load a database, execute the [api.loadDatabase](./ModuleServerAPI#loaddatabase) with the file location and a database specification. This specification tells the database handler which tables should exist with what columns. This specification is automatically parsed on load. New tables or columns will automatically be added and removed entries from the specification will also be removed from the database. The possible column types are `NULL`, `TEXT`, `INTEGER`, `REAL`, `BLOB`. For storing JSON objects use the `TEXT` type and for boolean use `INTEGER`. Below is an example of a database specification.
```JSON
{
"tableName": {
"columnName": {
"type": "TEXT",
"primary": true
},
"anotherColumnName": {
"type": "INTEGER"
}
},
"anotherTable": {
"columnName": {
"type": "TEXT",
"primary": true
},
"blobColumn": {
"type": "BLOB"
},
"readColumn": {
"type": "REAL"
}
}
}
```
## Database Instance
This is the class respresenting the entire database.
### close
Close the database.
```javascript
database.close();
```
### getTable
Get a table within the database.
```javascript
database.getTable(tableId);
```
| Argument | Type | Description |
| -------- | ------ | -------------------- |
| tableId | string | The ID of the table. |
**Return** [DatabaseTable](./ModuleServerAPIDatabase#databasetable-instance) _DatabaseTable instance_
### run
Run a raw sql query on the database.
```javascript
database.run(query, amps?:string[]);
```
| Argument | Type | Description |
| --------------- | -------- | ---------------------------------------------------- |
| query | string | The SQL query to run. |
| (Optional) amps | string[] | Safely include parameters to prevent SQL injections. |
**Returns** any[] _Returns from the query_
### fetchColumnsForTable
Fetch the column ids of a table.
| Argument | Type | Description |
| -------- | ------ | ----------------------------------- |
| table | string | The table to fetch the column from. |
## DatabaseTable Instance
Class respresenting a table within the database.
### getAllRows
Get all rows in the table.
```javascript
table.getAllRows();
```
**Returns** Promise\<{ [key:string]: any}[]> _All rows in the table._
### getPrimaryColumnValues
Get all primary column values.
```javascript
table.getPrimaryColumnValues();
```
**Returns** Promise\<string[]> _All rows in the table._
### getValue
Fetch the value of a specific cell.
```javascript
table.getValue(primaryKeyValue, columnId);
```
| Argument | Type | Description |
| --------------- | ------ | --------------------------------- |
| primaryKeyValue | string | The primary key value of the row. |
| columnId | string | The id of the column. |
**Returns** Promise\<any> _Value of the cell_
### getValueAsJSON
Fetch the value as JSON of a specific cell. JSON objects are saved as text so make sure the column type is `TEXT`.
```javascript
table.getValue(primaryKeyValue, columnId);
```
| Argument | Type | Description |
| --------------- | ------ | --------------------------------- |
| primaryKeyValue | string | The primary key value of the row. |
| columnId | string | The id of the column. |
**Returns** Promise\<object|array> _Value of the cell as JSON._
### getValueAsBoolean
Fetch the value as boolean of a specific cell. Booleans are saved a binary so make sure the column type is `INTEGER`.
```javascript
table.getValue(primaryKeyValue, columnId);
```
| Argument | Type | Description |
| --------------- | ------ | --------------------------------- |
| primaryKeyValue | string | The primary key value of the row. |
| columnId | string | The id of the column. |
**Returns** Promise\<boolean> _Value of the cell as boolean._
### updateRow
Update a row in the table.
```javascript
table.updateRow(primaryKeyValue, values);
```
| Argument | Type | Description |
| --------------- | ------------------------- | --------------------------------- |
| primaryKeyValue | string | The primary key value of the row. |
| values | { [columnId:string]: any} | The values to set. |
**Returns** Promise\<void> _Row has been updated._
### removeRow
Update a row in the table.
```javascript
table.removeRow(primaryKeyValue);
```
| Argument | Type | Description |
| --------------- | ------ | --------------------------------- |
| primaryKeyValue | string | The primary key value of the row. |
**Returns** Promise\<void> _Row has been removed._
### removeAllRows
Remove all rows in the table.
```javascript
table.removeAllRows();
```
**Returns** Promise\<void> _All rows have been removed._
### getPrimaryKeyColumn
Get the primary key column of the table.
```javascript
table.getPrimaryKeyColumn();
```
**Returns** string _The primary column id._

1
_Sidebar.md

@@ -27,6 +27,7 @@
- [Introduction](./ModuleServerAPIIntroduction) - [Introduction](./ModuleServerAPIIntroduction)
- [ModuleServerAPI](./ModuleServerAPI) - [ModuleServerAPI](./ModuleServerAPI)
- [Database](./ModuleServerAPIDatabase)
- [Client](./ModuleServerAPIClient) - [Client](./ModuleServerAPIClient)
- [Property](./ModuleServerAPIProperty) - [Property](./ModuleServerAPIProperty)
- [Important Principals](./ModuleServerAPIPrincipals) - [Important Principals](./ModuleServerAPIPrincipals)