@capawesome/capacitor-libsql 0.1.0

package/dist/docs.json

@@ -0,0 +1,684 @@
+{
+  "api": {
+    "name": "LibsqlPlugin",
+    "slug": "libsqlplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "beginTransaction",
+        "signature": "(options: BeginTransactionOptions) => Promise<BeginTransactionResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "BeginTransactionOptions"
+          }
+        ],
+        "returns": "Promise<BeginTransactionResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.0"
+          }
+        ],
+        "docs": "Begin a transaction on the specified database connection.\n\nOnly available on Android.",
+        "complexTypes": [
+          "BeginTransactionResult",
+          "BeginTransactionOptions"
+        ],
+        "slug": "begintransaction"
+      },
+      {
+        "name": "commitTransaction",
+        "signature": "(options: CommitTransactionOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "CommitTransactionOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.0"
+          }
+        ],
+        "docs": "Commit the current transaction on the specified database connection.\n\nOnly available on Android.",
+        "complexTypes": [
+          "CommitTransactionOptions"
+        ],
+        "slug": "committransaction"
+      },
+      {
+        "name": "connect",
+        "signature": "(options: ConnectOptions) => Promise<ConnectResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "ConnectOptions"
+          }
+        ],
+        "returns": "Promise<ConnectResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.0"
+          }
+        ],
+        "docs": "Connect to a database.\n\nThis method must be called before any other methods that interact with the database.",
+        "complexTypes": [
+          "ConnectResult",
+          "ConnectOptions"
+        ],
+        "slug": "connect"
+      },
+      {
+        "name": "execute",
+        "signature": "(options: ExecuteOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "ExecuteOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.0"
+          }
+        ],
+        "docs": "Execute a single SQL statement on the specified database connection.\n\nThis method can be used to execute any SQL statement, including `INSERT`, `UPDATE`, `DELETE`, and `CREATE TABLE`.",
+        "complexTypes": [
+          "ExecuteOptions"
+        ],
+        "slug": "execute"
+      },
+      {
+        "name": "executeBatch",
+        "signature": "(options: ExecuteBatchOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "ExecuteBatchOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.0"
+          }
+        ],
+        "docs": "Execute a batch of SQL statements on the specified database connection.\n\nThis method can be used to execute multiple SQL statements in a single call.",
+        "complexTypes": [
+          "ExecuteBatchOptions"
+        ],
+        "slug": "executebatch"
+      },
+      {
+        "name": "query",
+        "signature": "(options: QueryOptions) => Promise<QueryResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "QueryOptions"
+          }
+        ],
+        "returns": "Promise<QueryResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.0"
+          }
+        ],
+        "docs": "Query the database and return the result set.\n\nThis method can be used to execute `SELECT` statements and retrieve the result set.",
+        "complexTypes": [
+          "QueryResult",
+          "QueryOptions"
+        ],
+        "slug": "query"
+      },
+      {
+        "name": "rollbackTransaction",
+        "signature": "(options: RollbackTransactionOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "RollbackTransactionOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.0"
+          }
+        ],
+        "docs": "Rollback the current transaction on the specified database connection.\n\nThis method will undo all changes made in the current transaction.\n\nOnly available on Android.",
+        "complexTypes": [
+          "RollbackTransactionOptions"
+        ],
+        "slug": "rollbacktransaction"
+      },
+      {
+        "name": "sync",
+        "signature": "(options: SyncOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SyncOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.0"
+          }
+        ],
+        "docs": "Synchronize the database with the remote server.\n\nOnly available on iOS.",
+        "complexTypes": [
+          "SyncOptions"
+        ],
+        "slug": "sync"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "BeginTransactionResult",
+      "slug": "begintransactionresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "transactionId",
+          "tags": [
+            {
+              "text": "0.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The ID of the transaction that was started.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "BeginTransactionOptions",
+      "slug": "begintransactionoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "connectionId",
+          "tags": [
+            {
+              "text": "0.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The ID of the connection to begin the transaction on.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "CommitTransactionOptions",
+      "slug": "committransactionoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "connectionId",
+          "tags": [
+            {
+              "text": "0.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The ID of the connection to commit the transaction on.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "transactionId",
+          "tags": [
+            {
+              "text": "0.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The ID of the transaction to commit.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "ConnectResult",
+      "slug": "connectresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "connectionId",
+          "tags": [
+            {
+              "text": "0.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The ID of the connection.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "ConnectOptions",
+      "slug": "connectoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "authToken",
+          "tags": [
+            {
+              "text": "0.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The authentication token for the database.\n\nThis is required for connecting to a remote database.\nIf the database is local (i.e., a file on the device), this can be omitted.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "path",
+          "tags": [
+            {
+              "text": "0.0.0",
+              "name": "since"
+            },
+            {
+              "text": "'/data/user/0/com.example.plugin/cache/data.db'",
+              "name": "example"
+            }
+          ],
+          "docs": "The path to the database file.\n\nIf no path or URL is provided, the plugin will create a new in-memory database.\n\nIf no file exists at the specified path, a new file will be created.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "url",
+          "tags": [
+            {
+              "text": "0.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The URL of the database.\n\nThis can be used to connect to a remote database.\nIf the URL is provided, the `authToken` must also be provided.\n\nIf no path or URL is provided, the plugin will create a new in-memory database.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "ExecuteOptions",
+      "slug": "executeoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "connectionId",
+          "tags": [
+            {
+              "text": "0.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The ID of the connection to execute the SQL statement on.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "statement",
+          "tags": [
+            {
+              "text": "0.0.0",
+              "name": "since"
+            },
+            {
+              "text": "'INSERT INTO users (name, age) VALUES (?, ?)'",
+              "name": "example"
+            }
+          ],
+          "docs": "The SQL statement to execute.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "transactionId",
+          "tags": [
+            {
+              "text": "0.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The transaction ID to use for the SQL statement.\n\nOnly available on Android.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "values",
+          "tags": [
+            {
+              "text": "0.0.0",
+              "name": "since"
+            },
+            {
+              "text": "['Alice', 30]",
+              "name": "example"
+            }
+          ],
+          "docs": "The values to bind to the SQL statement.",
+          "complexTypes": [
+            "Value"
+          ],
+          "type": "Value[] | undefined"
+        }
+      ]
+    },
+    {
+      "name": "ExecuteBatchOptions",
+      "slug": "executebatchoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "connectionId",
+          "tags": [
+            {
+              "text": "0.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The ID of the connection to execute the batch on.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "statement",
+          "tags": [
+            {
+              "text": "0.0.0",
+              "name": "since"
+            },
+            {
+              "text": "['INSERT INTO users (name, age) VALUES (?, ?)', 'UPDATE users SET age = ? WHERE name = ?']",
+              "name": "example"
+            }
+          ],
+          "docs": "The SQL statements to execute in the batch.",
+          "complexTypes": [],
+          "type": "string[]"
+        },
+        {
+          "name": "values",
+          "tags": [
+            {
+              "text": "0.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The transaction ID to use for the batch.\n\nOnly available on Android.",
+          "complexTypes": [
+            "Value"
+          ],
+          "type": "Value[][] | undefined"
+        }
+      ]
+    },
+    {
+      "name": "QueryResult",
+      "slug": "queryresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "rows",
+          "tags": [
+            {
+              "text": "0.0.0",
+              "name": "since"
+            },
+            {
+              "text": "[['Alice', 30], ['Bob', 25]]",
+              "name": "example"
+            }
+          ],
+          "docs": "The values returned by the query.",
+          "complexTypes": [
+            "Value"
+          ],
+          "type": "Value[][]"
+        }
+      ]
+    },
+    {
+      "name": "QueryOptions",
+      "slug": "queryoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "connectionId",
+          "tags": [
+            {
+              "text": "0.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The ID of the connection to query.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "statement",
+          "tags": [
+            {
+              "text": "0.0.0",
+              "name": "since"
+            },
+            {
+              "text": "'SELECT name, age FROM users WHERE age > ?'",
+              "name": "example"
+            }
+          ],
+          "docs": "The SQL statement to execute.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "transactionId",
+          "tags": [
+            {
+              "text": "0.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The transaction ID to use for the query.\n\nOnly available on Android.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "values",
+          "tags": [
+            {
+              "text": "0.0.0",
+              "name": "since"
+            },
+            {
+              "text": "['Alice', 30]",
+              "name": "example"
+            }
+          ],
+          "docs": "The values to bind to the SQL statement.",
+          "complexTypes": [
+            "Value"
+          ],
+          "type": "Value[] | undefined"
+        }
+      ]
+    },
+    {
+      "name": "RollbackTransactionOptions",
+      "slug": "rollbacktransactionoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "connectionId",
+          "tags": [
+            {
+              "text": "0.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The ID of the connection to rollback the transaction on.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "transactionId",
+          "tags": [
+            {
+              "text": "0.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The ID of the transaction to rollback.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "SyncOptions",
+      "slug": "syncoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "connectionId",
+          "tags": [
+            {
+              "text": "0.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The ID of the connection to sync.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "Value",
+      "slug": "value",
+      "docs": "",
+      "types": [
+        {
+          "text": "string",
+          "complexTypes": []
+        },
+        {
+          "text": "number",
+          "complexTypes": []
+        },
+        {
+          "text": "null",
+          "complexTypes": []
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}