@basementuniverse/jsonpad-realtime-sdk 1.4.0 → 1.5.0

package/README.md

@@ -90,6 +90,8 @@ A connection that drops without closing cleanly keeps its slot on the server unt
 const jsonpadRealtime = new JSONPadRealtime('your-api-token', { retry: false });
 ```
 
+The same happens if you subscribe to items by alias while one of your alias indexes is still being built: the connection is refused with `INDEX_BUILDING` (code 16006), and retried once the server's suggested delay has passed. Subscribing by item id always works.
+
 ## `listen()` method
 
 The `listen()` method takes an array of event types to listen for. You can pass in any of the following event types:

package/build/jsonpad-realtime-sdk.d.ts

@@ -110,7 +110,8 @@ declare class ListEvent extends CustomEvent<any> {
  */
 declare class RealtimeErrorEvent extends CustomEvent<string> {
     /**
-     * The jsonpad error code, e.g. 10015, or null if the error didn't come from
+     * The jsonpad error code, e.g. 10015 (too many connections) or 16006 (an
+     * alias index is still being built), or null if the error didn't come from
      * the server
      */
     readonly code: number | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@basementuniverse/jsonpad-realtime-sdk",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "JSONPad Realtime SDK for Node and browser",
   "author": "Gordon Larrigan <gordonlarrigan@gmail.com> (https://gordonlarrigan.com)",
   "license": "MIT",

package/src/events/realtime-error-event.ts

@@ -9,7 +9,8 @@ import { RealtimeErrorData } from '../types';
  */
 export class RealtimeErrorEvent extends CustomEvent<string> {
   /**
-   * The jsonpad error code, e.g. 10015, or null if the error didn't come from
+   * The jsonpad error code, e.g. 10015 (too many connections) or 16006 (an
+   * alias index is still being built), or null if the error didn't come from
    * the server
    */
   public readonly code: number | null;