From 5624442bc12ae63f55c070af7bdc7aee8e40dc38 Mon Sep 17 00:00:00 2001 From: Matt Corallo Date: Sat, 8 Jan 2022 17:48:28 +0000 Subject: [PATCH] =?utf8?q?[TS]=20Update=20README=20to=20describe=20TS=20as?= =?utf8?q?=20"early=20alpha"=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 825c22c7..793d2ce8 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ To build for Apple M1 (ie aarch64-apple-darwin), you probably want something lik Status ====== -The TypeScript Bindings are still in early development and generated code contains syntax errors. +## Java While the underlying library and C bindings are relatively mature, the Java bindings should be 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 are likely some use-after-free or unkonwn-free bugs remaining. The debug-mode build links LLVM address sanitizer and will print diagnostic information in case of such issues. +## TypeScript + +The TypeScript bindings are functionally complete, but should be considered early alpha quality. +Some functions may error spuriously due to oversights or missing implementations. + +The TypeScript bindings require modern web standards, including support for `FinalizationRegistry` +and `WeakRef` (Chrome 84, Firefox 79, Safari 14.1/iOS 14.5 and Node 14.6) and WASM BigInt support +(Chrome 85, Firefox 78, Safari 14.1/iOS 14.5, and Node ??). + +## General + The only known issue resulting in a use-after-free bug requires custom a custom ChannelKeys instance created as a part of a new channel. After the channel is created, the ChannelKeys object will not be freed while the parent ChannelManager exists, however if the ChannelManager is garbage collected -- 2.30.2