Docs: New docs

This commit is contained in:
Sam 2025-03-27 09:58:54 +01:00
parent 03050d84bc
commit cd24369c65
10 changed files with 17 additions and 16 deletions

View File

@ -47,7 +47,7 @@ The new desired structure for the table to get.
***
### execute()
`async` → () → __any__
`async` → () → [Instance.checkStructure()](./instance#checkstructure)
:::warning Possible crash
[structure()](#structure) must always be given.

View File

@ -60,7 +60,7 @@ The desired structure for the table to get.
***
### execute()
`async` → () → __any__
`async` → () → [OkPacket](../typedefs/okpacket)
:::warning Possible crash
[structure()](#structure) must always be given.
@ -70,6 +70,6 @@ Executes the prepared query.
**Returns**
→ __any__ - The result of 'CREATE TABLE [...]'-query
→ [OkPacket](../typedefs/okpacket)
***

View File

@ -64,12 +64,12 @@ Enables deletion of all rows.
***
### execute()
`async` → () → __any__
`async` → () → [OkPacket](../typedefs/okpacket)
Executes the prepared query.
**Returns**
→ __any__ - Query result
→ [OkPacket](../typedefs/okpacket)
***

View File

@ -43,12 +43,12 @@ The data (rows) to insert.
***
### execute()
`async` → () → __any__
`async` → () → [OkPacket](../typedefs/okpacket)
Executes the prepared query.
**Returns**
→ __any__ - Query result
→ [OkPacket](../typedefs/okpacket)
***

View File

@ -293,12 +293,13 @@ Paginates the query.
***
### execute()
`async` → () → __any__
`async` &rarr; () &rarr; __Number__ / __Array__\<__Object__\>
Executes the prepared query.
**Returns**
&rarr; __any__ - Query result
&rarr; __Number__ - Numerical results<br/>
&rarr; __Array__\<__Object__\> - Row data
***

View File

@ -81,12 +81,12 @@ Adds a where-clause to the query
***
### execute()
`async` &rarr; () &rarr; __any__
`async` &rarr; () &rarr; [OkPacket](../typedefs/okpacket)
Executes the prepared query.
**Returns**
&rarr; __any__ - Query result
&rarr; [OkPacket](../typedefs/okpacket)
***

View File

@ -57,7 +57,7 @@ class Delete {
/**
* Executes the prepared querry
* @returns {Any}
* @returns {import("../index").OkPacket}
*/
async execute(){
if (!this.#instance.isConnected()) throw new Error(`Can't execute query: Instance has no connection`);

View File

@ -42,7 +42,7 @@ class Insert {
/**
* Executes the prepared querry
* @returns {Any}
* @returns {import("../index").OkPacket}
*/
async execute(){
if (!this.#data) throw new Error("Insert: tried to insert without data");

View File

@ -44,7 +44,7 @@ class AlterTable {
/**
* Executes the prepared querry
* @returns {Any}
* @returns {import("../index").CheckResult}
*/
async execute(){
if (!this.#database) throw new Error(`Can't alter table ${this.#name}: Database not selected`);
@ -170,7 +170,7 @@ class CreateTable {
/**
* Executes the prepared querry
* @returns {Any}
* @returns {import("../index").OkPacket}
*/
async execute(){
if (!this.#database) throw new Error(`Can't create table ${this.#name}: Database not selected`);

View File

@ -69,7 +69,7 @@ class Update{
/**
* Executes the prepared querry
* @returns {Any}
* @returns {import("../index").OkPacket}
*/
async execute(){
if (!this.#instance.isConnected()) throw new Error(`Can't execute query: Instance has no connection`);