From 03dc36d230b59cbaa21d8b4639f79404c966bff8 Mon Sep 17 00:00:00 2001 From: Roy Hashimoto Date: Mon, 23 Sep 2024 10:13:40 -0700 Subject: [PATCH] Rebuild docs. --- docs/assets/search.js | 2 +- docs/interfaces/SQLiteAPI.html | 19 +++++++++++++++++-- 2 files changed, 18 insertions(+), 3 deletions(-) diff --git a/docs/assets/search.js b/docs/assets/search.js index e3a446d..77a151f 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA62bW2/buBaF/4v6anRC8aIkb0UPChQYzHQmczoPRmAoMpMIlSWPJLvuBP3vB5Rva8ubCiOdx7R7cUn8FinKpF6iuvreRLfzl+hbXi6j2/jqJhE6nkVlurLRbXT3x695az9Wq3Xa5g+F/evH2kazaFMX0W3U/ljb5heu5P1zuyqiWZQVadPYJrqNop+zk4c2vfa/fro7NZqXra0f0+zU8tdPd4PNiatYndpb7b6k7fNv7o9XG3xHiqHtWbROa1u25Prg+q/U9clw97GomhCzU+FYoz9tugzxOdSNtfm7ztug+zkWjjX6q96UWRrmBbVj7e5+lFmI1aFurM2nvLB3+b9BdwW1Y+1+rbJvIVaHurE2/y2LQKNT5ejx9Gyzb3/axtZbuwy9PU40heDHqmzrqgiFeC4fa/ofu80z+/E5rdOstXXetHnWhNj7hGMv5Pe1LUN8D3Xj77ewYUP/VDnW6kOW2SaoL0+Vb7C6eJZ9qa1T/L5u86ocsKV14U+4Tdlk1doOPAqYlt+BaujmehfvuYTHIn162529O0pGmV928ocvn/3+H758Hl5/YDwe8nK5yKqisJmzfb3Vd5eKoZtyVzpgHeg3zWTxUFQPoXd2qJ1it6w2D8XA4KaGp+oplnnZhvrtSyeaGfUGu654imG5KQaeRdTvUDvFbp3W6cq2tl5k1Sa8Yy9l/5+LKAdX875rKF9f1r92Ca3dBd/8oXakXfaclk92YE49mZ0rx1oVNq0X7przcmgWPzv2BaONB1+UwO/196Qhm6rYrELm8VPhJKPQuZVWT7T80YZlhZZPMw2dCnrl00yDnyT9+mm2YU8TUjzZMOiJ0iufZho4r9Lq6ZZvSO6xfJpp4DROqyda4s9kr1vuq8da1jZt7eJxU4auYC8VI62XaZsGTwykeKSh3dmBH3FOVoeykSaPeZkWgz/hnIygdKTZk20X6aatsmq1ykO68UIw0rjIH7a2bsISQ4onGy7KzerB1m/yPWtG24f177FupE21tuViGwcYnStHWq3r6qm2TbN4TstlEdSfjGSkeW0bG9Kdx7rxNpsi0GdfOMkodDVHq6dZBq9x+vXTbMPWOKR4smHQGqdXPs008M2ZVk+zDFxu0OqxltX3EKuuaqRFs3/ePFd1/m/QHHMhGGv8Twi5fdVYizZt7cqWbcialBSPNrTrIKuubKTJNi02IfPJsW6KTeiESYqnGQa+/NLqSZbBM3SvfJJp2PyMtVPtgmZnWj3JMnCiJMXTDMPeykjxWMPHZlHbp7xpg+bMXvmrpvezKC+XdhfdvkTHhfltFL+X72+iWfSY22LpTnVEx5f2auUmruj+8H9fbdZWtavYl/xyFc3mVzN5816L+P5+Nj8quv/o/qErE9FsLrgyQcriaDaPubKYlMloNpdcmSRlKprNFVemSJmOZnPNlWlSZqLZ3HBlhpQl0WyecGUJKbuOZvNrruyalN1Es/kNV3ZDu9f1tmA5iB6IjgSPgrIQrs8FS0NQHMJ1u2CBCEpEuJ4XLBNBoQjX+YLFIigX4fpfsGQERSMcAsHCEZSOcBQEy0dQQMKBECwiQRnFDkTMMoopo9iBiFlGcW+8dAOGHzGUUexAxCyjmDKKHYiYZRRTRrEDEbOMYsoodiBillFMGcUORMwyiimj2IGIWUYxZRQ7EDHLKKaMpAMhWUaSMpIOhGQZScpIOhCSZSR701o3r/ETG2UkHQjJMpKUkXQgJMtIUkbSgZAsI0kZSQdCsowkZSQdCMkykpSRdCAky0hSRsqBUCwjRRkpB0KxjBRlpBwIxTJSlJFyIBTLSPWePt3jh3/+UEbKgVAsI0UZKQdCsYwUZaQcCMUyUpSRciAUy0hRRsqBUCwjRRlpB0KzjDRlpB0IzTLSlJF2IDTLSFNG2oHQLCNNGWkHQrOMdG+R0K0S+GUCZaQdCM0y0pSRdiA0y0hTRtqB0CwjTRlpB0KzjDRlZBwIwzIylJFxIAzLyFBGxoEwLCNDGRkHwrCMDGXkXhfmhmVkKCPjQBiWkemt5brFHL+ao4yMA2FYRoYyMg6EYRkZysg4EIZlZCijxIFIWEYJZZQ4EAnLKKGMEgciYRkllFHiQCQso4QyShyIhGWUUEaJA5GwjBLKKHEgEpZRsmfUvctsbd3a5ef9O818fjgb9RItDq858elI+ksUx9Hty8+f59ca95drGM4vgVKCUg4p8UwX6AXoxZD++N4PWgVaNaTt3uBBqEGoXxG68QNSA1IzJN3/2gnKBJTJkPLipA80cg2NXIc1sn9LhTZuoI2boTb2vwqclfLqrJRXHuXpCA3oALL0Qe4fhAE5pFP60nk41wIqSKb0JfN4SgVkECrpCxU5bgJayJX05YoeGwExJEv6kkWPf4AYwiV94eqd4gA1pEr6UoXnMUAKYZK+MNFzFWexgjwpb57wgARoIVPKmyly0AHEkCjlTRSeWAAt5EoN5+rwKxdoIVzKG67++QHQQ8CUL2B4EgCkEC/li9d+Zx9EECvli9V5lx6EkCjlS9Th1PJZJSBMwhem/g49mIJc+eS4136Wakii9iWR2S6HFiCP2pfHw+43qCCI2hfE1W6dts8X0zjM4h7haQ8cDCG92pfey31saAAirH0RPmxLgwqCq33BPW4ygwxCq32hJbvFoIXsal92e5u+oIYAa1+AcfsWpBBD7Ysh3YY9iw0E0fiCSPZTQQsRNL4Iko1R0EKcjC9P3U4naCBLxpel/n4lyCFJxpekbgMSNJAj48tR80+RtzZd52S4QMfGvo7dK7PTx5b9+RvaGG5ivf/Yojp+pgJzHMRS+GK5b2T7SJUg9OlgExU6DUaR8Y2i/aYoiOA6je86z9+9wGXCyBG+kbPdb46CHajMoOpioBsYb8Y33ra4X3nWJkA08SHdkn1HEAORxIdke95CBCWMtsQ32ra4FwhaGHWJb9RtYVcPpDDiEt+I28L+HEhh4CW+gUf32UAMAUx8Adylh+/DIEqgE15d5r5OrA9fJ+4/j4QmcNT4GO0uXx5gVesTLQ+fzoEZdJLwddJu2X1TmPW/KYRmwF147R/zwmbHLyNBDNESvmh14qa3ZoMR6BuAu373wtDzjbxd1X3LCFcIKRS+FO7q7jtrWNzB2s6nabqPiyF3EDufpj19+wwzCkwoPt2mvIgazCXCN5fsvu+/64blAqwWONH9LFrna1vkpY1u5/c/f/4Pnq/we1ZAAAA="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA61bW2/buBr8L+qr0Q3Fi5K8FT0oUGCx293s6T4YgaHITCJUlryS7Lob9L8fUL7NJ39UGOk8Np3hSN8MLzLJl6iuvjfR7fwl+paXy+g2vrpJhI5nUZmubHQb3f3xa97aj9Vqnbb5Q2H/+rG20Sza1EV0G7U/1rb5hYO8f25XRTSLsiJtGttEt1H0c3bS0KbX/tdPd6dG87K19WOanVr++ulusDlxFatTe6vdl7R9/s3949UG3xEwtD2L1mlty5Y8Hzz/lbo+Ce4+FlUTInYCjhX606bLEJ0DbqzM33XeBr3PEThW6K96U2ZpmBZgx8rd/SizEKkDbqzMp7ywd/m/QW8F2LFyv1bZtxCpA26szH/LIlDohBzdn55t9u1P29h6a5ehr8eRpjj4sSrbuipCTTzDx4r+x27zzH58Tus0a22dN22eNSHyPuLYB/l9bcsQ3QNu/PsWNqzrn5BjpT5kmW2CanlCvkHqYi77UlvH+H3d5lU5IEtx4TPcpmyyam0HpgKm5XfAGnq53sN7HuGxSJ/e9mbvjpRR4pdF/vDls1//w5fPw+sPjMdDXi4XWVUUNnOyr7f67pIx9FLuSQekA/WmiSweiuoh9M0O2Clyy2rzUAx0bip4Qk+RzMs2VG8PnShm1BvkOvAUwXJTDMxFVO+AnSK3Tut0ZVtbL7JqE17YS9r/5yHKwdW87xnK15f1rz1Ca3fBL3/AjpTLntPyyQ6MqSexM3KsVGHTeuGeOS+HRvGzYp8wWnjwQwn0Xv9OGpKpis0qZBw/AScJhY6tFD1R8kcblhUKnyYaOhT04NNEg2eSPn6abNhsQsCTBYNmlB58mmjguErR0yXfkNwjfJpo4DBO0RMl8Wey1yX36LGStU1bu3jclKEr2EvGSOll2qbBAwMBjxS0OzvwI85J6gAbKfKYl2kx+BPOSQigI8WebLtIN22VVatVHlLGC8JI4SJ/2Nq6CUsMAU8WXJSb1YOt36R75oyWD6vvETdSplrbcrGNA4TOyJFS67p6qm3TLJ7TclkE1ZOhjBSvbWNDynnEjZfZFIE6e+AkodDVHEVPkwxe4/Tx02TD1jgEPFkwaI3Tg08TDfxypuhpkoHLDYoeK1l9D5HqUCMlmv1881zV+b9BY8wFYazwPyHO7VFjJdq0tStbtiFrUgIeLWjXQVIdbKTIZr10y7vnqhrYOzlpUfRIyW1abEKGsCNuikzoGE3A0wQDv7cpepJk8KTQg08SDZsSEDtVLmhCoOhJkoFjMwFPEwz7ECTgsYKPzaK2T3nTBg3TPfirovezKC+XdhfdvkTHb4HbKH4v399Es+gxt8XSHSSJjr8TVCs3Vkb3h//7arO2qh1iD/nlKprNr2by5r1R9/ez+ZHQ/b37Q4cS0WwuGJQgqDiazWMGFROUjGZzyaAkQaloNlcMShGUjmZzzaA0QZloNjcMyhBUEs3mCYNKCOo6ms2vGdQ1Qd1Es/kNg7qhVXVFFlz1Ra/8Xf1ZA6gDwpVacB4IaoJw1RacDYL6IFzBBeeEoFYIV3PBmSGoG8KVXXB+CGqIcJUXnCWCeiJc8QXniqC2CFd/wRkjqDOxq3/MORNTZ2JX/5hzJu71ja5zsL2DOhO7+secMzF1Jnb1jzlnYupM7Oofc87E1JnY1T/mnImpM7Grf8w5E1NnYlf/mHMmps7Erv4x50xMnZGu/pJzRlJnpKu/5JyR1Bnp6i85Z2Rv4OpGLnboos5IV3/JOSOpM9LVX3LOSOqMdPWXnDOSOiNd/SXnjKTOSFd/yTkjqTPS1V9yzkjqjHL1V5wzijqjXP0V54yizihXf8U5o6gzytVfcc6o3qzSTSvsvEKdUa7+inNGUWeUq7/inFHUGeXqrzhnFHVGuforzhlFnVGu/opzRlFntKu/5pzR1Bnt6q85ZzR1Rrv6a84ZTZ3Rrv6ac0ZTZ7Srv+ac0b0pv5vz2UmfOqNd/TXnjKbOaFd/zTmjqTPa1V9zzmjqjHb115wzmjpjXP0N54yhzhhXf8M5Y6gzxtXfcM4Y6oxx9TecM4Y645b7c8M5Y6gzxtXfcM6Y3nqsW5CxKzLqjHH1N5wzhjpjXP0N54yhzhhXf8M5Y6gziat/wjmTUGcSV/+EcyahziSu/gnnTEKdSVz9E86ZhDqTuPonnDMJdSZx9U84ZxLqTOLqn3DOJL3FcrdaZpfLe2e675StrVu7/Lz/XpnPD0etXqLF4RMmPp1wf4niOLp9+fnz/Mni/uUahuNQwJTAlENMPCIGfAF8McQ/ftMDVwFXDXG7r3MgaiDqV4iucwHVANUMUfc/ngIzAWYyxLw4OASNXEMj12GN7L9AoY0baONmqI39F/+ZKa/OTHnlYZ5O5AAPTJY+k/vnaoAO6ZS+dB6OyQALkil9yTweegEahEr6QkVOrwAXciV9uaKnUIAMyZK+ZNHTJECGcElfuHqHQoANqZK+VOHxDqBCmKQvTPSYxpmsIE/Kmyc8bwFcyJTyZoqcmwAyJEp5E4UHIIALuVLDuTr8ggVcCJfyhqt/HAH4EDDlCxgeLAAqxEv54rU/KAAkiJXyxeq86Q9ESJTyJepwCPrMEhAm4QtTf8MfRIGufHTcuj9TNSRR+5LI7L5DC5BH7cvjYTMdWBBE7QviardO2+eLYRxGcQ/xtKUOgpBe7Uvv5bY4NAAR1r4IH3a5gQXB1b7gHvesgQah1b7Qks1n4EJ2tS+7vT1kYEOAtS/AuBsMVIih9sWQ7uqeyQaCaHxBJNuzwIUIGl8EyT4rcCFOxpenbuMUOJAl48tSf/sT6JAk40tSt58JHMiR8eWo+afIW5uuc9JdoLCxr7B7Zna6u9kfv6GN4SbW+7sb1fHWC4xxEEvhi+W+ke0jZQLRx4M9WSga9CLj60X7PVYgwXMa33Oer9HAY0LPEb6eQ3ZZQRS4xsfd7jdNgQUdzvg63Ba2P8/UBBxNfJZucR8TuGBI4nNkS/YjgQz9LfH1t+15axGY0OsSX6/b4h4hcKHLJb4ut4XdPqBCz0t8PW8L+3ZAhfwlvvzR/TcgQw4TXw536eGqGsQQRIVPdJe5i5L14aLk/qYmNIE9zmfw7vLDA1bEPtLycIsPxKC+wlff3bK73pj1rzdCM6AuvPKPeWGz4yVNIEMohS+UHbnprfeg3/q67a5fXui1vk67q7prlfCEEGDhC/Cu7q58w8IQ1oU+TtPdc4bcQex8nPZ0DRsGIxiLfLxNeRE1GIeEbxzafd9fMYelBqw0ONL9LFrna1vkpY1u5/c/f/4PkqjPcOFAAAA="; \ No newline at end of file diff --git a/docs/interfaces/SQLiteAPI.html b/docs/interfaces/SQLiteAPI.html index 5243897..167ba2f 100644 --- a/docs/interfaces/SQLiteAPI.html +++ b/docs/interfaces/SQLiteAPI.html @@ -10,7 +10,7 @@ 
// Import an ES6 module factory function from one of the
// package builds, either 'wa-sqlite.mjs' (synchronous) or
// 'wa-sqlite-async.mjs' (asynchronous). You should only
// use the asynchronous build if you plan to use an
// asynchronous VFS or module.
import SQLiteESMFactory from 'wa-sqlite/dist/wa-sqlite.mjs';

// Import the Javascript API wrappers.
import * as SQLite from 'wa-sqlite';

// Use an async function to simplify Promise handling.
(async function() {
  // Invoke the ES6 module factory to create the SQLite
  // Emscripten module. This will fetch and compile the
  // .wasm file.
  const module = await SQLiteESMFactory();

  // Use the module to build the API instance.
  const sqlite3 = SQLite.Factory(module);

  // Use the API to open and access a database.
  const db = await sqlite3.open_v2('myDB');
  ...
})();

See

https://sqlite.org/c3ref/funclist.html

-
interface SQLiteAPI {
    bind(stmt, i, value): number;
    bind_blob(stmt, i, value): number;
    bind_collection(stmt, bindings): number;
    bind_double(stmt, i, value): number;
    bind_int(stmt, i, value): number;
    bind_int64(stmt, i, value): number;
    bind_null(stmt, i): number;
    bind_parameter_count(stmt): number;
    bind_parameter_name(stmt, i): string;
    bind_text(stmt, i, value): number;
    changes(db): number;
    clear_bindings(stmt): number;
    close(db): Promise<number>;
    column(stmt, i): SQLiteCompatibleType;
    column_blob(stmt, i): Uint8Array;
    column_bytes(stmt, i): number;
    column_count(stmt): number;
    column_double(stmt, i): number;
    column_int(stmt, i): number;
    column_int64(stmt, i): bigint;
    column_name(stmt, i): string;
    column_names(stmt): string[];
    column_text(stmt, i): string;
    column_type(stmt, i): number;
    create_function(db, zFunctionName, nArg, eTextRep, pApp, xFunc?, xStep?, xFinal?): number;
    data_count(stmt): number;
    exec(db, zSQL, callback?): Promise<number>;
    finalize(stmt): Promise<number>;
    get_autocommit(db): number;
    libversion(): string;
    libversion_number(): number;
    limit(db, id, newVal): number;
    open_v2(zFilename, iFlags?, zVfs?): Promise<number>;
    progress_handler(db, nProgressOps, handler, userData): any;
    reset(stmt): Promise<number>;
    result(context, value): void;
    result_blob(context, value): void;
    result_double(context, value): void;
    result_int(context, value): void;
    result_int64(context, value): void;
    result_null(context): void;
    result_text(context, value): void;
    row(stmt): SQLiteCompatibleType[];
    set_authorizer(db, authFunction, userData): number;
    sql(stmt): string;
    statements(db, sql, options?): AsyncIterable<number>;
    step(stmt): Promise<number>;
    value(pValue): SQLiteCompatibleType;
    value_blob(pValue): Uint8Array;
    value_bytes(pValue): number;
    value_double(pValue): number;
    value_int(pValue): number;
    value_int64(pValue): bigint;
    value_text(pValue): string;
    value_type(pValue): number;
    vfs_register(vfs, makeDefault?): number;
}

Methods

bind +
interface SQLiteAPI {
    bind(stmt, i, value): number;
    bind_blob(stmt, i, value): number;
    bind_collection(stmt, bindings): number;
    bind_double(stmt, i, value): number;
    bind_int(stmt, i, value): number;
    bind_int64(stmt, i, value): number;
    bind_null(stmt, i): number;
    bind_parameter_count(stmt): number;
    bind_parameter_name(stmt, i): string;
    bind_text(stmt, i, value): number;
    changes(db): number;
    clear_bindings(stmt): number;
    close(db): Promise<number>;
    column(stmt, i): SQLiteCompatibleType;
    column_blob(stmt, i): Uint8Array;
    column_bytes(stmt, i): number;
    column_count(stmt): number;
    column_double(stmt, i): number;
    column_int(stmt, i): number;
    column_int64(stmt, i): bigint;
    column_name(stmt, i): string;
    column_names(stmt): string[];
    column_text(stmt, i): string;
    column_type(stmt, i): number;
    create_function(db, zFunctionName, nArg, eTextRep, pApp, xFunc?, xStep?, xFinal?): number;
    data_count(stmt): number;
    exec(db, zSQL, callback?): Promise<number>;
    finalize(stmt): Promise<number>;
    get_autocommit(db): number;
    libversion(): string;
    libversion_number(): number;
    limit(db, id, newVal): number;
    open_v2(zFilename, iFlags?, zVfs?): Promise<number>;
    progress_handler(db, nProgressOps, handler, userData): any;
    reset(stmt): Promise<number>;
    result(context, value): void;
    result_blob(context, value): void;
    result_double(context, value): void;
    result_int(context, value): void;
    result_int64(context, value): void;
    result_null(context): void;
    result_text(context, value): void;
    row(stmt): SQLiteCompatibleType[];
    set_authorizer(db, authFunction, userData): number;
    sql(stmt): string;
    statements(db, sql, options?): AsyncIterable<number>;
    step(stmt): Promise<number>;
    update_hook(db, callback): void;
    value(pValue): SQLiteCompatibleType;
    value_blob(pValue): Uint8Array;
    value_bytes(pValue): number;
    value_double(pValue): number;
    value_int(pValue): number;
    value_int64(pValue): bigint;
    value_text(pValue): string;
    value_type(pValue): number;
    vfs_register(vfs, makeDefault?): number;
}

Methods

bind bind_blob bind_collection bind_double @@ -57,6 +57,7 @@ sql statements step +update_hook value value_blob value_bytes @@ -328,6 +329,20 @@

Returns Promise<number>

Promise resolving to SQLITE_ROW or SQLITE_DONE (rejects on error)

See

https://www.sqlite.org/c3ref/step.html

+

update_hook

  • update_hook(db, callback): void

  • Register an update hook

    +

    The callback is invoked whenever a row is updated, inserted, or deleted +in a rowid table on this connection.

    +

    Parameters

    • db: number

      database pointer

      +
    • callback: ((updateType, dbName, tblName, rowid) => void)
        • (updateType, dbName, tblName, rowid): void

        • Parameters

          • updateType: number
          • dbName: string
          • tblName: string
          • rowid: bigint

          Returns void

    Returns void

    See

    +

    updateType is one of:

    +

value

  • value(pValue): SQLiteCompatibleType

  • Extract a value from sqlite3_value

    This is a convenience function that calls the appropriate value_* function based on its type. Note that if the value is a blob then as @@ -371,4 +386,4 @@

    Parameters

    • vfs: SQLiteVFS

      VFS object

    • Optional makeDefault: boolean

    Returns number

    SQLITE_OK (throws exception on error)

    See

    https://www.sqlite.org/c3ref/vfs_find.html

    -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file