diff --git a/Documentation/Gateway.md b/Documentation/Gateway.md index 975b69d..b38ae29 100644 --- a/Documentation/Gateway.md +++ b/Documentation/Gateway.md @@ -40,4 +40,29 @@ This class is rather used than a Connection when initialised in a multithreaded > | Method | String | Method or property of the Connection to select. | > | Parameters | ...Any | Additional parameters to give to the function. | > -> Returns **{Promise}** Result of the thread. +> Returns **{Promise}** Result from the thread. + +## [.Set(KeyOrPath, Value)](https://github.com/QSmally/QDB/blob/v4/lib/Executors/Pool/ThreadProvider/Gateway.js#L66) [**Async**] +> Manages the elements of the database. Asynchronously performs this query. +> | Key | Type | Description | +> | --- | --- | --- | +> | KeyOrPath | Pathlike | Specifies at what row to insert or replace the element at. | +> | Value | Object, Array, Any | Data to set at the row address, at the location of the key or path. | +> +> Returns **{Promise}** Result from the thread. + +## [.Fetch(KeyOrPath)](https://github.com/QSmally/QDB/blob/v4/lib/Executors/Pool/ThreadProvider/Gateway.js#L78) [**Async**] +> Manages the retrieval of the database. Asynchronously performs this query. +> | Key | Type | Description | +> | --- | --- | --- | +> | KeyOrPath | Pathlike | Specifies which row to fetch from the database. | +> +> Returns **{Promise}** Result from the thread. + +## [.Erase(Keys)](https://github.com/QSmally/QDB/blob/v4/lib/Executors/Pool/ThreadProvider/Gateway.js#L89) [**Async**] +> Manages the deletion of the database. Asynchronously performs this query. +> | Key | Type | Description | +> | --- | --- | --- | +> | Keys | ...Pathlike | A key or multiple keys to remove from the database. | +> +> Returns **{Promise}** Result from the thread. diff --git a/Documentation/Output.json b/Documentation/Output.json index 5af7a98..ae42e10 100644 --- a/Documentation/Output.json +++ b/Documentation/Output.json @@ -582,7 +582,7 @@ "Variable", "Private" ], - "Line": 67, + "Line": 64, "Description": "The manager that handles backups of this Pool.", "Type": "{Function?}" }, @@ -592,7 +592,7 @@ "Variable", "Private" ], - "Line": 78, + "Line": 75, "Description": "When this Pool is threaded, a reference to the manager which holds the worker thread.", "Type": "{ThreadProvider?}" }, @@ -677,7 +677,44 @@ "{String} Method Method or property of the Connection to select.", "{...Any} Parameters Additional parameters to give to the function." ], - "Returns": "{Promise} Result of the thread." + "Returns": "{Promise} Result from the thread." + }, + { + "Value": "Set", + "Flags": [ + "Async" + ], + "Line": 66, + "Description": "Manages the elements of the database. Asynchronously performs this query.", + "Params": [ + "{Pathlike} KeyOrPath Specifies at what row to insert or replace the element at.", + "{Object|Array|*} Value Data to set at the row address, at the location of the key or path." + ], + "Returns": "{Promise} Result from the thread." + }, + { + "Value": "Fetch", + "Flags": [ + "Async" + ], + "Line": 78, + "Description": "Manages the retrieval of the database. Asynchronously performs this query.", + "Params": [ + "{Pathlike} KeyOrPath Specifies which row to fetch from the database." + ], + "Returns": "{Promise} Result from the thread." + }, + { + "Value": "Erase", + "Flags": [ + "Async" + ], + "Line": 89, + "Description": "Manages the deletion of the database. Asynchronously performs this query.", + "Params": [ + "{...Pathlike} Keys A key or multiple keys to remove from the database." + ], + "Returns": "{Promise} Result from the thread." } ], "PartialConnection": [