Merge pull request #68 from dtex/Relay

Relay

Author: dtex

build/templates/class.js

@@ -0,0 +1,78 @@
+/**
+ * Class template
+ * @module j5e/XXX
+ * @requires module:j5e/event
+ * @requires module:j5e/fn
+ */
+
+import { Emitter } from "j5e/event";
+import { normalizeParams, getProvider } from "j5e/fn";
+
+/**
+ * Class representing XXX
+ * @classdesc The XXX class allows for control of XXX
+ * @async
+ * @extends Emitter
+ * @fires Switch#XXX
+ * @fires Switch#XXX
+ */
+class XXX extends Emitter {
+
+  #state = {
+    someStateProp: true
+  };
+
+  /**
+   * Instantiate XXX
+   * @param {object} options - A pin number, pin identifier or a complete IO options object (See {@tutorial C-INSTANTIATING}
+   * @property {boolean} XXX - True if XXX
+   * @example
+   * <caption>Use an XXX</caption>
+   * import XXX from "j5e/XXX";
+   *
+   * const myxxx = await new XXX(12);
+   *
+   */
+  constructor(options) {
+    return (async() => {
+      options = normalizeParams(options);
+      super();
+
+      const Provider = await getProvider(options, "builtin/digital");
+      this.io = new Provider({
+        pin: options.pin,
+        mode: Provider.Input,
+        onReadable: () => {
+          this.emit(this.isOpen ? "open" : "close");
+        }
+      });
+
+      Object.defineProperties(this, {
+        XXX: {
+          get: () => {
+            return Boolean(this.io.XXX);
+          }
+        }
+      });
+
+      return this;
+    })();
+
+  }
+
+  /**
+   * doSomething
+   * @return {XXX}
+   * @example
+   * import XXX from "j5e/XXX";
+   *
+   * const myXXX = await new XXX(12);
+   * myXXX.doSomething();
+   */
+  doSomething() {
+    return this;
+  }
+
+}
+
+export default XXX;