Skip to content

Commit 5624442

Browse files
committed
[TS] Update README to describe TS as "early alpha" 🚀
1 parent aa53e31 commit 5624442

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

‎README.md‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ To build for Apple M1 (ie aarch64-apple-darwin), you probably want something lik
3939
Status
4040
======
4141

42-
The TypeScript Bindings are still in early development and generated code contains syntax errors.
42+
## Java
4343

4444
While the underlying library and C bindings are relatively mature, the Java bindings should be
4545
considered beta quality and some issues may still appear. Specifically, because the Java bindings
@@ -53,6 +53,17 @@ exit there will likely be many false positives. While it will require some compl
5353
are likely some use-after-free or unkonwn-free bugs remaining. The debug-mode build links LLVM
5454
address sanitizer and will print diagnostic information in case of such issues.
5555

56+
## TypeScript
57+
58+
The TypeScript bindings are functionally complete, but should be considered early alpha quality.
59+
Some functions may error spuriously due to oversights or missing implementations.
60+
61+
The TypeScript bindings require modern web standards, including support for `FinalizationRegistry`
62+
and `WeakRef` (Chrome 84, Firefox 79, Safari 14.1/iOS 14.5 and Node 14.6) and WASM BigInt support
63+
(Chrome 85, Firefox 78, Safari 14.1/iOS 14.5, and Node ??).
64+
65+
## General
66+
5667
The only known issue resulting in a use-after-free bug requires custom a custom ChannelKeys instance
5768
created as a part of a new channel. After the channel is created, the ChannelKeys object will not
5869
be freed while the parent ChannelManager exists, however if the ChannelManager is garbage collected

0 commit comments

Comments
 (0)