Added

Author: djthorpe

.github/workflows/publish.yaml

@@ -0,0 +1,18 @@
+name: Node.js Package
+on:
+  release:
+    types: [created]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-node@v2
+      with:
+        node-version: '12.x'
+        registry-url: 'https://npm.pkg.github.com'
+        scope: '@djthorpe'
+    - run: npm install
+    - run: npm publish
+      env:
+        NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.npmrc

@@ -0,0 +1 @@
+@djthorpe:registry=https://npm.pkg.github.com

README.md

@@ -8,11 +8,55 @@ implementation which provides the following classes:
   * __Model class__: subclass this for your JSON models, and separately define the members of your class;
   * __View classes__: classes are provided for form, list, button, etc.
 
-## Usage
+## Clone
 
-You'll need to use `npm` to install as a dependency in your module:
+You'll need to use `npm` to install as a dependency in your module. Here is what
+I do on my Mac which has homebrew installed:
 
 ```bash
-[bash] npm install github:djthorpe/js-framework
+[bash] brew install npm
+[bash] cd $PROJECTS
+[bash] git clone git@github.com:djthorpe/js-framework.git
+[bash] cd js-framework
+[bash] npm install
 ```
 
+## Test
+
+## Provider
+
+The provider is used to fetch JSON objects and arrays from a remote REST source, and stores them. To construct a provider with a model class called MyModelClass,
+
+```javascript
+import Provider from '@djthorpe/js-framework';
+import MyModelClass from './models';
+
+const origin = 'https://awesome-data-service.com/';
+const provider = new Provider(MyModelClass,origin);
+```
+
+If the __Model__ class is not provided then a plain vanilla object
+is used. The origin is also optional.
+
+You can create a request to a remote API using the `request` method, which will
+return immediately, whilst firing events,
+
+```javascript
+const path = '/api/datasource';
+const req = { method: 'GET' };
+const userInfo = null;
+const interval = 30 * 1000; // Request every 30 seconds
+provider.request(path,req,userInfo,interval);
+```
+
+The `req`, `userInfo` and `interval` arguments are optional. If you use
+an interval, a request is immediately made and then again periodically. To
+cancel an interval, call `provider.cancel();`.
+
+The events fired are as followed:
+
+`mvc.provider.added` (sender,object)
+`mvc.provider.changed` (sender,object,existing)
+`mvc.provider.deleted` (sender,object)
+`mvc.provider.completed` (sender,changed)
+`mvc.provider.error` (sender,Error)

etc/rpi4b.conf

@@ -20,18 +20,18 @@ export default class Provider extends Emitter {
   constructor(constructor, origin) {
     super();
     this.$origin = origin || '';
-    this.$constructor = typeof constructor === 'function' ? constructor : Object;
+    this.$constructor = constructor || Object;
     this.$objs = new Map();
     this.$timer = null;
   }
 
-  request(url, req, userInfo, interval) {
+  request(url, req, interval) {
     this.cancel();
     if (!this.$timer) {
-      this.$fetch(url, req, userInfo);
+      this.$fetch(url, req);
     }
     if (interval) {
-      this.$timer = setInterval(this.$fetch.bind(this, url, req, userInfo), interval);
+      this.$timer = setInterval(this.$fetch.bind(this, url, req), interval);
     }
   }
 
@@ -42,7 +42,7 @@ export default class Provider extends Emitter {
     }
   }
 
-  $fetch(url, req, userInfo) {
+  $fetch(url, req) {
     let status;
     let changed = false;
     fetch(this.$origin + url, req)
@@ -76,11 +76,11 @@ export default class Provider extends Emitter {
         }
       })
       .then(() => {
-        this.dispatchEvent(EVENT_COMPLETED, this, changed, userInfo);
+        this.dispatchEvent(EVENT_COMPLETED, this, changed);
       })
       .catch((error) => {
         if (error instanceof Error) {
-          this.dispatchEvent(EVENT_ERROR, this, error, userInfo);
+          this.dispatchEvent(EVENT_ERROR, this, error);
         } else {
           throw error;
         }