Skip to content

Commit b50a35e

Browse files
committed
Add notes for experimental dart2wasm support
1 parent e64935c commit b50a35e

File tree

3 files changed

+13
-3
lines changed

3 files changed

+13
-3
lines changed

sqlite3/CHANGELOG.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
1-
## 2.4.3-dev
1+
## 2.4.3
22

33
- Migrate away from legacy web APIs: `dart:html`, `dart:js`, `dart:indexeddb`
44
and `package:js` are no longer imported from this package.
5+
- Experimentally support being compiled to WebAssembly. Strong caveats apply,
6+
please check [#230](https://github.com/simolus3/sqlite3.dart/issues/230)
7+
before relying on this!
58

69
## 2.4.2
710

sqlite3/README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,10 @@ For a more complete example on how to use this library, see the [example](https:
2020

2121
You can use this library on any platform where you can obtain a `DynamicLibrary` with symbols
2222
from `sqlite3`.
23-
In addition, this package experimentally supports the web through WebAssembly.
23+
In addition, this package supports running on the web by accessing a sqlite3
24+
build compiled to WebAssembly.
25+
Web support is only official supported for `dartdevc` and `dart2js`. Support
26+
for `dart2wasm` [is experimental and incomplete](https://github.com/simolus3/sqlite3.dart/issues/230).
2427

2528
Here's how to use this library on the most popular platforms:
2629

@@ -91,6 +94,10 @@ This package experimentally supports being used on the web with a bit of setup.
9194
The web version binds to a custom version of sqlite3 compiled to WebAssembly without
9295
Emscripten or any JavaScript glue code.
9396

97+
Please note that stable web support for `package:sqlite3` is restricted to Dart
98+
being compiled to JavaScript. Support for `dart2wasm` is experimental. The API
99+
is identical, but the implementation [is severly limited](https://github.com/simolus3/sqlite3.dart/issues/230).
100+
94101
### Setup
95102

96103
To use this package on the web, you need:

sqlite3/pubspec.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: sqlite3
22
description: Provides lightweight yet convenient bindings to SQLite by using dart:ffi
3-
version: 2.4.2
3+
version: 2.4.3
44
homepage: https://github.com/simolus3/sqlite3.dart/tree/main/sqlite3
55
issue_tracker: https://github.com/simolus3/sqlite3.dart/issues
66

0 commit comments

Comments
 (0)