File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -64,7 +64,46 @@ SQLite's [SQLCipher extension](https://github.com/sqlcipher/sqlcipher) is also
6464
6565# API
6666
67- See the [ API documentation] ( https://github.com/gms1/node-sqlite3/wiki/API ) in the wiki.
67+ See the [ API documentation] ( docs/API.md ) for detailed documentation of both the callback-based and Promise-based APIs.
68+
69+ ## Quick Example
70+
71+ ### Callback-based API (Traditional)
72+
73+ ``` js
74+ const sqlite3 = require (' @homeofthings/sqlite3' ).verbose ();
75+ const db = new sqlite3.Database (' :memory:' );
76+
77+ db .serialize (() => {
78+ db .run (" CREATE TABLE lorem (info TEXT)" );
79+ db .run (" INSERT INTO lorem VALUES (?)" , [' test' ]);
80+ db .each (" SELECT * FROM lorem" , (err , row ) => {
81+ console .log (row);
82+ });
83+ });
84+
85+ db .close ();
86+ ```
87+
88+ ### Promise-based API (Modern)
89+
90+ ``` js
91+ const { SqliteDatabase } = require (' @homeofthings/sqlite3' );
92+
93+ async function main () {
94+ const db = await SqliteDatabase .open (' :memory:' );
95+
96+ await db .run (" CREATE TABLE lorem (info TEXT)" );
97+ await db .run (" INSERT INTO lorem VALUES (?)" , [' test' ]);
98+
99+ const rows = await db .all (" SELECT * FROM lorem" );
100+ console .log (rows);
101+
102+ await db .close ();
103+ }
104+
105+ main ().catch (console .error );
106+ ```
68107
69108# Usage
70109
You can’t perform that action at this time.
0 commit comments