node-web-gpio 1.0.12 → 1.0.14

package/dist/index.d.ts

@@ -1,24 +1,53 @@
 /// <reference types="node" />
 import { EventEmitter } from 'events';
+/** ポート番号 */
 declare type PortNumber = number;
+/** ポート名 */
 declare type PortName = string;
+/** ピン名 */
 declare type PinName = string;
+/** 入出力方向 */
 declare type DirectionMode = 'in' | 'out';
+/** GPIO 値 0: LOW / 1: HIGH */
 declare type GPIOValue = 0 | 1;
+/**
+ * GPIO チェンジイベント
+ */
 interface GPIOChangeEvent {
+    /** 入出力値 */
     readonly value: GPIOValue;
+    /** ポート */
     readonly port: GPIOPort;
 }
+/**
+ * GPIO チェンジイベントハンドラ
+ */
 interface GPIOChangeEventHandler {
+    /** イベント */
     (event: GPIOChangeEvent): void;
 }
+/**
+ * GPIO
+ */
 export declare class GPIOAccess extends EventEmitter {
+    /** ポート */
     private readonly _ports;
+    /** GPIO チェンジイベントハンドラ */
     onchange: GPIOChangeEventHandler | undefined;
+    /**
+     * Creates an instance of GPIOAccess.
+     * @param ports ポート番号
+     */
     constructor(ports?: GPIOPortMap);
+    /**
+     * ポート情報取得処理
+     * @return 現在のポート情報
+     */
     get ports(): GPIOPortMap;
     /**
      * Unexport all exported GPIO ports.
+     * 全てのポート開放をする
+     * @return ポート開放結果
      */
     unexportAll(): Promise<void>;
 }
@@ -27,30 +56,97 @@ export declare class GPIOAccess extends EventEmitter {
  */
 export declare class GPIOPortMap extends Map<PortNumber, GPIOPort> {
 }
+/**
+ * GPIO ポート
+ */
 export declare class GPIOPort extends EventEmitter {
+    /** ポート番号 */
     private readonly _portNumber;
+    /** ポーリング間隔 */
     private readonly _pollingInterval;
+    /** 入出力方向 */
     private _direction;
+    /** エクスポート */
     private _exported;
+    /** エクスポートリトライ回数 */
     private _exportRetry;
+    /** 入出力値 */
     private _value;
+    /** タイムアウト値 */
     private _timeout;
+    /** GPIO チェンジイベントハンドラ */
     onchange: GPIOChangeEventHandler | undefined;
+    /**
+     * Creates an instance of GPIOPort.
+     * @param portNumber ポート番号
+     */
     constructor(portNumber: PortNumber);
+    /**
+     * ポート番号取得処理
+     * @return 現在のポート番号
+     */
     get portNumber(): PortNumber;
+    /**
+     * ポート名取得処理
+     * @return 現在のポート名
+     */
     get portName(): PortName;
+    /**
+     * ピン名取得処理
+     * @return 現在のピン名
+     */
     get pinName(): PinName;
+    /**
+     * GPIO 入出力方向 getter
+     * @return 現在のGPIO 入出力方向
+     */
     get direction(): DirectionMode;
+    /**
+     * GPIO export の有無 getter
+     * @return 現在のGPIO 出力
+     */
     get exported(): boolean;
+    /**
+     * GPIO 出力処理
+     * @param direction GPIO 入出力方向
+     * @return export 処理の完了
+     */
     export(direction: DirectionMode): Promise<void>;
+    /**
+     * Unexport exported GPIO ports.
+     * ポート開放をする
+     * @return ポート開放処理の完了
+     */
     unexport(): Promise<void>;
+    /**
+     * 入力値読み取り処理
+     * @return 読み取り処理の完了
+     */
     read(): Promise<GPIOValue>;
+    /**
+     * 出力値書き込み処理
+     * @return 読み取り処理の完了
+     */
     write(value: GPIOValue): Promise<void>;
 }
+/**
+ * 無効なアクセスエラー
+ */
 export declare class InvalidAccessError extends Error {
+    /**
+     * Creates an instance of InvalidAccessError.
+     * @param message エラーメッセージ
+     */
     constructor(message: string);
 }
+/**
+ * 操作エラー
+ */
 export declare class OperationError extends Error {
+    /**
+     * Creates an instance of OperationError.
+     * @param message エラーメッセージ
+     */
     constructor(message: string);
 }
 export declare function requestGPIOAccess(): Promise<GPIOAccess>;

package/dist/index.js

@@ -8,9 +8,24 @@ const path = require("path");
  * Interval of file system polling, in milliseconds.
  */
 const PollingInterval = 100;
+/**
+ * GPIO パス
+ */
 const SysfsGPIOPath = '/sys/class/gpio';
+/**
+ * GPIO ポートマップサイズ
+ */
 const GPIOPortMapSizeMax = 1024;
+/**
+ * Uint16 Max サイズ
+ */
 const Uint16Max = 65535;
+/**
+ *
+ * Uint16型変換処理
+ * @param parseString 変換文字列
+ * @return Uint16型変換値
+ */
 function parseUint16(parseString) {
     const n = Number.parseInt(parseString, 10);
     if (0 <= n && n <= Uint16Max)
@@ -18,9 +33,18 @@ function parseUint16(parseString) {
     else
         throw new RangeError(`Must be between 0 and ${Uint16Max}.`);
 }
+/**
+ * GPIO
+ */
 class GPIOAccess extends events_1.EventEmitter {
+    /** ポート */
     _ports;
+    /** GPIO チェンジイベントハンドラ */
     onchange;
+    /**
+     * Creates an instance of GPIOAccess.
+     * @param ports ポート番号
+     */
     constructor(ports) {
         super();
         this._ports = ports == null ? new GPIOPortMap() : ports;
@@ -32,11 +56,17 @@ class GPIOAccess extends events_1.EventEmitter {
                 this.onchange(event);
         });
     }
+    /**
+     * ポート情報取得処理
+     * @return 現在のポート情報
+     */
     get ports() {
         return this._ports;
     }
     /**
      * Unexport all exported GPIO ports.
+     * 全てのポート開放をする
+     * @return ポート開放結果
      */
     async unexportAll() {
         await Promise.all([...this.ports.values()].map((port) => port.exported ? port.unexport() : undefined));
@@ -49,15 +79,30 @@ exports.GPIOAccess = GPIOAccess;
 class GPIOPortMap extends Map {
 }
 exports.GPIOPortMap = GPIOPortMap;
+/**
+ * GPIO ポート
+ */
 class GPIOPort extends events_1.EventEmitter {
+    /** ポート番号 */
     _portNumber;
+    /** ポーリング間隔 */
     _pollingInterval;
+    /** 入出力方向 */
     _direction;
+    /** エクスポート */
     _exported;
+    /** エクスポートリトライ回数 */
     _exportRetry;
+    /** 入出力値 */
     _value;
+    /** タイムアウト値 */
     _timeout;
+    /** GPIO チェンジイベントハンドラ */
     onchange;
+    /**
+     * Creates an instance of GPIOPort.
+     * @param portNumber ポート番号
+     */
     constructor(portNumber) {
         super();
         this._portNumber = parseUint16(portNumber.toString());
@@ -70,26 +115,51 @@ class GPIOPort extends events_1.EventEmitter {
                 this.onchange(event);
         });
     }
+    /**
+     * ポート番号取得処理
+     * @return 現在のポート番号
+     */
     get portNumber() {
         return this._portNumber;
     }
+    /**
+     * ポート名取得処理
+     * @return 現在のポート名
+     */
     get portName() {
         return `gpio${this.portNumber}`;
     }
+    /**
+     * ピン名取得処理
+     * @return 現在のピン名
+     */
     get pinName() {
         // NOTE: Unknown pinName.
         return '';
     }
+    /**
+     * GPIO 入出力方向 getter
+     * @return 現在のGPIO 入出力方向
+     */
     get direction() {
         if (this._direction instanceof OperationError)
             throw this._direction;
         return this._direction;
     }
+    /**
+     * GPIO export の有無 getter
+     * @return 現在のGPIO 出力
+     */
     get exported() {
         if (this._exported instanceof OperationError)
             throw this._exported;
         return this._exported;
     }
+    /**
+     * GPIO 出力処理
+     * @param direction GPIO 入出力方向
+     * @return export 処理の完了
+     */
     async export(direction) {
         if (!/^(in|out)$/.test(direction)) {
             throw new InvalidAccessError(`Must be "in" or "out".`);
@@ -127,6 +197,11 @@ class GPIOPort extends events_1.EventEmitter {
         this._direction = direction;
         this._exported = true;
     }
+    /**
+     * Unexport exported GPIO ports.
+     * ポート開放をする
+     * @return ポート開放処理の完了
+     */
     async unexport() {
         clearInterval(this._timeout);
         try {
@@ -137,6 +212,10 @@ class GPIOPort extends events_1.EventEmitter {
         }
         this._exported = false;
     }
+    /**
+     * 入力値読み取り処理
+     * @return 読み取り処理の完了
+     */
     async read() {
         if (!(this.exported && this.direction === 'in')) {
             throw new InvalidAccessError(`The exported must be true and value of direction must be "in".`);
@@ -154,6 +233,10 @@ class GPIOPort extends events_1.EventEmitter {
             throw new OperationError(error);
         }
     }
+    /**
+     * 出力値書き込み処理
+     * @return 読み取り処理の完了
+     */
     async write(value) {
         if (!(this.exported && this.direction === 'out')) {
             throw new InvalidAccessError(`The exported must be true and value of direction must be "out".`);
@@ -167,14 +250,28 @@ class GPIOPort extends events_1.EventEmitter {
     }
 }
 exports.GPIOPort = GPIOPort;
+/**
+ * 無効なアクセスエラー
+ */
 class InvalidAccessError extends Error {
+    /**
+     * Creates an instance of InvalidAccessError.
+     * @param message エラーメッセージ
+     */
     constructor(message) {
         super(message);
         this.name = this.constructor.name;
     }
 }
 exports.InvalidAccessError = InvalidAccessError;
+/**
+ * 操作エラー
+ */
 class OperationError extends Error {
+    /**
+     * Creates an instance of OperationError.
+     * @param message エラーメッセージ
+     */
     constructor(message) {
         super(message);
         this.name = this.constructor.name;
@@ -191,6 +288,11 @@ async function requestGPIOAccess() {
     return new GPIOAccess(ports);
 }
 exports.requestGPIOAccess = requestGPIOAccess;
+/**
+ * 待機 関数
+ * @param ms スリープ時間（ミリ秒）
+ * @return 待機完了
+ */
 function sleep(ms) {
     return new Promise((resolve) => {
         return setTimeout(resolve, ms);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-web-gpio",
-  "version": "1.0.12",
+  "version": "1.0.14",
   "description": "GPIO access with Node.js",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -21,13 +21,17 @@
     "husky": "^7.0.4",
     "lint-staged": "^12.1.2",
     "prettier": "^2.5.1",
+    "typedoc": "^0.22.10",
     "typescript": "^4.2.3"
   },
   "scripts": {
     "build": "tsc",
     "lint": "eslint index.ts",
     "prepare": "husky install && rm -rf dist && npm run build",
-    "precommit": "lint-staged"
+    "precommit": "lint-staged",
+    "docs": "npm run remove:docs && npm run typedoc -- --options typedoc.json --exclude '**/*.spec.ts' ./ README.md",
+    "typedoc": "typedoc",
+    "remove:docs": "rm -rf docs"
   },
   "keywords": [
     "gpio",