@graffy/client 0.15.18 → 0.15.19-alpha.1

package/Readme.md

@@ -1,9 +1,29 @@
 # Graffy Client
 
-Graffy client library for the browser.
+Graffy client library for the browser, usin the `fetch()` or `WebSocket` APIs. This module is intended to be used with a Node.js server running Graffy Server.
 
-It uses the `fetch()` and `EventStream` APIs, and requires these to be polyfilled by your application if you wish to support Internet Explorer.
+## Usage
 
-Graffy Client is intended to be used with a Node.js server running Graffy Server, but should work with any server implementing the [Graffy/HTTP protocol](https://aravindet.github.io/graffy/#/Protocol).
+```js
+import Graffy from '@graffy/core';
+import client from '@graffy/client';
+
+const store = new Graffy();
+store.use(client(url, options));
+
+// Add downstream providers to the store
+```
+
+An HTTP connection is used if the URL begins with `http(s)://`, and a Websocket is used if it begins with `ws(s)://`.
+
+### Options
+
+- `getOptions(operation, payload, options)`, a callback to get the options that should be passed to the server with each operation.
+- `connInfoPath`, a location in the store to put connection metadata. Defaults to `connection`.
+
+### Connection status
+
+If using a WebSocket connection, Graffy client creates a `connection: { status: boolean }` node in the store. The location of this node can be controlled by the `connInfoPath` option. Reading from or watching this node provides information about the current connection status. The application may explicitly tear-down or re-establish connections by writing `false` or `true` to it, respectively.
+
+See [Graffy documentation](https://graffy.org#/GraffyClient) for more.
 
-See [Graffy documentation](https://aravindet.github.io/graffy/#/GraffyClient) for more.

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@graffy/client",
-  "description": "Graffy client library for the browser.",
+  "description": "Graffy client library for the browser, usin the `fetch()` or `WebSocket` APIs. This module is intended to be used with a Node.js server running Graffy Server.",
   "author": "aravind (https://github.com/aravindet)",
-  "version": "0.15.18",
+  "version": "0.15.19-alpha.1",
   "main": "./index.cjs",
   "exports": {
     "import": "./index.mjs",
@@ -16,8 +16,8 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@graffy/common": "0.15.18",
-    "@graffy/stream": "0.15.18",
+    "@graffy/stream": "0.15.19-alpha.1",
+    "@graffy/common": "0.15.19-alpha.1",
     "debug": "^4.3.3"
   }
 }