@laplace.live/ws 7.1.9 → 8.0.0

package/README.md

@@ -16,6 +16,12 @@ A modern, web-standard rewrite of [bilibili-live-ws](https://github.com/simon300
 bun add @laplace.live/ws
 ```
 
+## Requirements
+
+TypeScript **5.7 or newer**. The binary surface uses the generic typed-array
+types (`Uint8Array<ArrayBuffer>`) introduced in TS 5.7, so older compilers will
+report `Uint8Array is not generic`.
+
 ## Usage
 
 Known Bilibili events are auto-typed via `LiveEventMap` — no manual generics
@@ -104,13 +110,19 @@ The `relayEvent` symbol is replaced by an `event` meta-event:
 ### Buffer → Uint8Array
 
 Raw data uses `Uint8Array` instead of `Buffer`. If you pass a custom
-`authBody` as binary, use `Uint8Array`:
+`authBody` as binary, use an `ArrayBuffer`-backed `Uint8Array<ArrayBuffer>`:
 
 ```diff
 - live = new LiveWS(roomid, { authBody: Buffer.from(...) });
 + live = new LiveWS(roomid, { authBody: new Uint8Array(...) });
 ```
 
+`new Uint8Array(...)` already allocates an `ArrayBuffer`-backed view. If you
+hold a value typed as a bare `Uint8Array` (i.e. `Uint8Array<ArrayBufferLike>`,
+whose buffer could be a `SharedArrayBuffer`), narrow it to
+`Uint8Array<ArrayBuffer>` or copy it with `new Uint8Array(data)` before passing
+it to `authBody` or `send`.
+
 ## License
 
 MIT

package/dist/browser.d.ts

@@ -1,7 +1,6 @@
-import { K as KeepLive, b as LiveWSBase, W as WSOptions } from './ws-mjTot1Nb.js';
-export { c as LaplaceEventTarget, d as LaplaceRawEvent, e as LiveEventMap, a as LiveOptions } from './ws-mjTot1Nb.js';
-import '@laplace.live/internal';
+import { a as LiveOptions, c as LiveEventMap, n as WSOptions, o as LaplaceEventTarget, r as KeepLive, s as LaplaceRawEvent, t as LiveWSBase } from "./ws-BsvxqaEF.js";
 
+//#region src/browser.d.ts
 /**
  * WebSocket client for a Bilibili live room (browser).
  *
@@ -21,7 +20,7 @@ import '@laplace.live/internal';
  * ```
  */
 declare class LiveWS extends LiveWSBase {
-    constructor(roomid: number, opts?: WSOptions);
+  constructor(roomid: number, opts?: WSOptions);
 }
 /**
  * Auto-reconnecting WebSocket client for a Bilibili live room (browser).
@@ -42,7 +41,7 @@ declare class LiveWS extends LiveWSBase {
  * ```
  */
 declare class KeepLiveWS extends KeepLive<LiveWSBase> {
-    constructor(roomid: number, opts?: WSOptions);
+  constructor(roomid: number, opts?: WSOptions);
 }
-
-export { KeepLiveWS, LiveWS, WSOptions };
+//#endregion
+export { KeepLiveWS, LaplaceEventTarget, LaplaceRawEvent, type LiveEventMap, type LiveOptions, LiveWS, type WSOptions };