iconfig and docs build script

Author: sevenbitbyte

scripts/build-docs.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+set -x
+
+rm -rf docs
+npm run generate-docs
+mv docs/@dataparty/api/1.2.17/* docs/
+cp -r images/ docs

src/config/iconfig.js

@@ -0,0 +1,15 @@
+
+/**
+ * @interface
+ */
+class IConfig {
+    async start(){ throw 'not implemented' }
+    async clear(){ throw 'not implemented' }
+    readAll(){ throw 'not implemented' }
+    read(key){ throw 'not implemented' }
+    async write(key, data){ throw 'not implemented' }
+    exists(key){ throw 'not implemented' }
+    async save(){ throw 'not implemented' }
+}
+
+module.exports = IConfig

src/config/index.js

@@ -3,9 +3,15 @@ const MemoryConfig = require('./memory')
 const JsonFileConfig = require('./json-file')
 const LocalStorageConfig = require('./local-storage')
 
-module.exports = {
+/**
+ * Config
+ * @namespace Config
+ */
+const Config = {
   NconfConfig,
   MemoryConfig,
   JsonFileConfig,
   LocalStorageConfig
-}
+}
+
+module.exports = Config

src/config/json-file.js

@@ -10,8 +10,9 @@ const logger = require('debug')('dataparty.config.json-file')
 const IConfig = require('./iconfig')
 
 /**
- * @class
+ * @class Config.JsonFileConfig
  * @implements {IConfig}
+ * @namespace Config
  */
 class JsonFileConfig extends IConfig {