mention ignored configs

Author: DaBigBlob

src/client.ts

@@ -1,7 +1,7 @@
 import type { TransactionMode, rawSQLStatement, libsqlConfig, rawSQLArgs, rawSQL, ResultSet, clientInterface } from "./commons.js";
 import { libsqlBatchWithoutTransaction, libsqlBatch, libsqlExecute, libsqlExecuteMultiple, libsqlMigrate } from "./functions.js";
 import { MisuseError } from "./errors.js";
-import { checkHttpUrl, conserror, ensure_fetch } from "./globcon/mod.js";
+import { checkHttpUrl, checkRedundantConfig, conserror, ensure_fetch } from "./globcon/mod.js";
 import type { libsqlBatchReqStepExecCond } from "libsql-stateless";
 
 export function createClient(conf: libsqlConfig) {
@@ -12,58 +12,20 @@ export function createClient(conf: libsqlConfig) {
 export class libsqlClient implements clientInterface {
     private readonly conf: libsqlConfig;
     public closed: boolean;
-
-    /** Which protocol does the client use?
-     *
-     * - `"http"` if the client connects over HTTP
-     * - `"ws"` if the client connects over WebSockets
-     * - `"file"` if the client works with a local file
-     */
     public protocol: string;
 
     constructor(conf: libsqlConfig) {
         if (!conf.disableCriticalChecks) {
             checkHttpUrl(conf.url);
             ensure_fetch(conf);
+            checkRedundantConfig(conf);
         }
 
         this.conf = conf;
         this.closed = false;
         this.protocol = "http";
     }
 
-    /** Execute a single SQL statement.
-     *
-     * Every statement executed with this method is executed in its own logical database connection. If you
-     * want to execute a group of statements in a transaction, use the {@link batch} method.
-     *
-     * ```javascript
-     * // execute a statement without arguments
-     * const rs = await client.execute("SELECT * FROM books");
-     *
-     * // execute a statement with positional arguments
-     * const rs = await client.execute(
-     *     "SELECT * FROM books WHERE author = ?",
-     *     ["Jane Austen"],
-     * );
-     * // for backward compatibality
-     * const rs = await client.execute({
-     *     sql: "SELECT * FROM books WHERE author = ?",
-     *     args: ["Jane Austen"],
-     * });
-     *
-     * // execute a statement with named arguments
-     * const rs = await client.execute(
-     *     "SELECT * FROM books WHERE published_at > $year",
-     *     {year: 1719},
-     * );
-     * // for backward compatibality
-     * const rs = await client.execute({
-     *     sql: "SELECT * FROM books WHERE published_at > $year",
-     *     args: {year: 1719},
-     * });
-     * ```
-     */
     public async execute(stmt: rawSQL, args?: rawSQLArgs, want_rows?: boolean): Promise<ResultSet>;
     public async execute(stmt: rawSQLStatement): Promise<ResultSet>;
     public async execute(stmt_or_sql: rawSQL|rawSQLStatement, or_args?: rawSQLArgs, or_want_rows?: boolean) {
@@ -128,8 +90,7 @@ export class libsqlClient implements clientInterface {
         return await libsqlMigrate(this.conf, stmts);
     }
 
-    // @ts-ignore
-    public async transaction(mode?: TransactionMode): Promise<any> {
+    public async transaction(_mode?: TransactionMode): Promise<any> {
         throw new MisuseError("'libsql-stateless' is stateless and does not support interactive transactions. Use this.batch() instead.");
     }
 

src/globcon/mod.ts

@@ -40,4 +40,12 @@ export function checkHttpUrl(url: string) {
         'This is a HTTP client and only supports "https:" and "http:" URLs. For modern libsql DBs simply changing "libsql://" to "https://" should resolve this.',
         "URL_SCHEME_NOT_SUPPORTED",
     );
+}
+
+export function checkRedundantConfig(conf: libsqlConfig) {
+    if (conf.encryptionKey) conserror("'encryptionKey' config unsupported.");
+    if (conf.syncUrl) conserror("'syncUrl' config unsupported because 'url' is the remote url. (embedded replicas unsupported)");
+    if (conf.syncInterval) conserror("'syncInterval' config unsupported because nothing to sync. (embedded replicas unsupported)");
+    if (conf.tls) conserror("'tls' config unsupported. Change url scheme to 'http' for no tls and 'https' for tls.");
+    if (conf.concurrency) conserror("'concurrency' config unsupported. You may use a custom fetch to specify concurrency.");
 }