@@ -12,20 +12,17 @@ npm install @sqlite.org/sqlite-wasm
1212
1313> [ !Warning]
1414>
15- > This project wraps the code of
16- > [ SQLite Wasm] ( https://sqlite.org/wasm/doc/trunk/index.md ) with _ no_ changes,
17- > apart from added TypeScript types. Please do _ not_ file issues or feature
18- > requests regarding the underlying SQLite Wasm code here. Instead, please
19- > follow the
20- > [ SQLite bug filing instructions] ( https://www.sqlite.org/src/wiki?name=Bug+Reports ) .
21- > Filing TypeScript type related issues and feature requests is fine.
15+ > This project wraps the code of [ SQLite Wasm] ( https://sqlite.org/wasm/doc/trunk/index.md ) with _ no_
16+ > changes, apart from added TypeScript types. Please do _ not_ file issues or feature requests
17+ > regarding the underlying SQLite Wasm code here. Instead, please follow the
18+ > [ SQLite bug filing instructions] ( https://www.sqlite.org/src/wiki?name=Bug+Reports ) . Filing
19+ > TypeScript type related issues and feature requests is fine.
2220
2321## Node.js support
2422
2523> [ !Warning]
2624>
27- > Node.js is currently only supported for in-memory databases without
28- > persistence.
25+ > Node.js is currently only supported for in-memory databases without persistence.
2926
3027## Usage
3128
@@ -34,8 +31,7 @@ There are two ways to use SQLite Wasm:
3431- [ in a worker] ( #in-a-worker-with-opfs-if-available )
3532- [ in the main thread] ( #in-the-main-thread-without-opfs )
3633
37- Only the worker versions allow you to use the origin private file system (OPFS)
38- storage back-end.
34+ Only the worker versions allow you to use the origin private file system (OPFS) storage back-end.
3935
4036### In a worker (with OPFS if available):
4137
@@ -116,8 +112,8 @@ The `db` object above implements the
116112
117113## Usage with vite
118114
119- If you are using [ vite] ( https://vitejs.dev/ ) , you need to add the following
120- config option in ` vite.config.js ` :
115+ If you are using [ vite] ( https://vitejs.dev/ ) , you need to add the following config option in
116+ ` vite.config.js ` :
121117
122118``` js
123119import { defineConfig } from ' vite' ;
@@ -135,38 +131,33 @@ export default defineConfig({
135131});
136132```
137133
138- Check out a
139- [ sample project] ( https://stackblitz.com/edit/vitejs-vite-ttrbwh?file=main.js )
140- that shows this in action.
134+ Check out a [ sample project] ( https://stackblitz.com/edit/vitejs-vite-ttrbwh?file=main.js ) that shows
135+ this in action.
141136
142137## Demo
143138
144- See the [ demo] ( https://github.com/sqlite/sqlite-wasm/tree/main/demo ) folder for
145- examples of how to use this in the main thread and in a worker. (Note that the
146- worker variant requires special HTTP headers, so it can't be hosted on GitHub
147- Pages.) An example that shows how to use this with vite is available on
148- [ StackBlitz] ( https://stackblitz.com/edit/vitejs-vite-ttrbwh?file=main.js ) .
139+ See the [ demo] ( https://github.com/sqlite/sqlite-wasm/tree/main/demo ) folder for examples of how to
140+ use this in the main thread and in a worker. (Note that the worker variant requires special HTTP
141+ headers, so it can't be hosted on GitHub Pages.) An example that shows how to use this with vite is
142+ available on [ StackBlitz] ( https://stackblitz.com/edit/vitejs-vite-ttrbwh?file=main.js ) .
149143
150144## Projects using this package
151145
152- See the list of
153- [ npm dependents] ( https://www.npmjs.com/browse/depended/@sqlite.org/sqlite-wasm )
154- for this package.
146+ See the list of [ npm dependents] ( https://www.npmjs.com/browse/depended/@sqlite.org/sqlite-wasm ) for
147+ this package.
155148
156149## Deploying a new version
157150
158151(These steps can only be executed by maintainers.)
159152
160- 1 . Manually trigger the
161- [ GitHub Actions workflow] ( ../../actions/workflows/build-wasm.yml ) . By
162- default, it uses the latest SQLite tag. This pull request will contain the
163- latest ` sqlite3.wasm ` and related bindings.
153+ 1 . Manually trigger the [ GitHub Actions workflow] ( ../../actions/workflows/build-wasm.yml ) . By
154+ default, it uses the latest SQLite tag. This pull request will contain the latest ` sqlite3.wasm `
155+ and related bindings.
164156
165- 2 . Once the above pull request is validated and merged, update the version
166- number in ` package.json ` , reflecting the current
167- [ SQLite version number] ( https://sqlite.org/download.html ) and add a build
168- identifier suffix like ` -build1 ` . The complete version number should read
169- something like ` 3.41.2-build1 ` .
157+ 2 . Once the above pull request is validated and merged, update the version number in ` package.json ` ,
158+ reflecting the current [ SQLite version number] ( https://sqlite.org/download.html ) and add a build
159+ identifier suffix like ` -build1 ` . The complete version number should read something like
160+ ` 3.41.2-build1 ` .
170161
171162## Building the SQLite Wasm locally
172163
@@ -210,9 +201,9 @@ for this package.
210201
211202## Running tests
212203
213- The test suite consists of Node.js tests and browser-based tests (using Vitest
214- Browser Mode). Tests aim to sanity-check the exported scripts. We test for
215- correct exports and ** very ** basic functionality.
204+ The test suite consists of Node.js tests and browser-based tests (using Vitest Browser Mode). Tests
205+ aim to sanity-check the exported scripts. We test for correct exports and ** very ** basic
206+ functionality.
216207
2172081 . Install dependencies:
218209
@@ -234,18 +225,17 @@ correct exports and **very** basic functionality.
234225
235226## Deprecations
236227
237- The Worker1 and Promiser1 APIs are, as of 2026-04-15, deprecated. They _ will not
238- be removed_ , but they also will not be extended further. It is their author's
239- considered opinion that they are too fragile, too imperformant, and too limited
240- for any non-toy software, and their use is _ actively discouraged_ . The "correct"
241- way to use this library is documented in [ Usage] ( #usage ) section above.
228+ The Worker1 and Promiser1 APIs are, as of 2026-04-15, deprecated. They _ will not be removed_ , but
229+ they also will not be extended further. It is their author's considered opinion that they are too
230+ fragile, too imperformant, and too limited for any non-toy software, and their use is _ actively
231+ discouraged_ . The "correct" way to use this library is documented in [ Usage] ( #usage ) section above.
242232
243233## License
244234
245235Apache 2.0.
246236
247237## Acknowledgements
248238
249- This project is based on [ SQLite Wasm] ( https://sqlite.org/wasm ) , which it
250- conveniently wraps as an ES Module and publishes to npm as
239+ This project is based on [ SQLite Wasm] ( https://sqlite.org/wasm ) , which it conveniently wraps as an
240+ ES Module and publishes to npm as
251241[ ` @sqlite.org/sqlite-wasm ` ] ( https://www.npmjs.com/package/@sqlite.org/sqlite-wasm ) .
0 commit comments