dualsense-ts 2.0.0 → 2.0.3

package/docs/UnisenseParams.md

@@ -0,0 +1,105 @@
+# Interface: UnisenseParams
+
+## Hierarchy
+
+- [`InputParams`](../wiki/InputParams)
+
+  ↳ **`UnisenseParams`**
+
+## Table of contents
+
+### Properties
+
+- [analog](../wiki/UnisenseParams#analog)
+- [bumper](../wiki/UnisenseParams#bumper)
+- [icon](../wiki/UnisenseParams#icon)
+- [name](../wiki/UnisenseParams#name)
+- [parent](../wiki/UnisenseParams#parent)
+- [threshold](../wiki/UnisenseParams#threshold)
+- [trigger](../wiki/UnisenseParams#trigger)
+
+## Properties
+
+### analog
+
+• `Optional` **analog**: [`InputParams`](../wiki/InputParams)
+
+#### Defined in
+
+[src/elements/unisense.ts:10](https://github.com/nsfm/dualsense-ts/blob/6dc1604/src/elements/unisense.ts#L10)
+
+___
+
+### bumper
+
+• `Optional` **bumper**: [`InputParams`](../wiki/InputParams)
+
+#### Defined in
+
+[src/elements/unisense.ts:9](https://github.com/nsfm/dualsense-ts/blob/6dc1604/src/elements/unisense.ts#L9)
+
+___
+
+### icon
+
+• `Optional` **icon**: `string`
+
+#### Inherited from
+
+[InputParams](../wiki/InputParams).[icon](../wiki/InputParams#icon)
+
+#### Defined in
+
+[src/input.ts:6](https://github.com/nsfm/dualsense-ts/blob/6dc1604/src/input.ts#L6)
+
+___
+
+### name
+
+• `Optional` **name**: `string`
+
+#### Inherited from
+
+[InputParams](../wiki/InputParams).[name](../wiki/InputParams#name)
+
+#### Defined in
+
+[src/input.ts:5](https://github.com/nsfm/dualsense-ts/blob/6dc1604/src/input.ts#L5)
+
+___
+
+### parent
+
+• `Optional` **parent**: [`Input`](../wiki/Input)<`unknown`\>
+
+#### Inherited from
+
+[InputParams](../wiki/InputParams).[parent](../wiki/InputParams#parent)
+
+#### Defined in
+
+[src/input.ts:8](https://github.com/nsfm/dualsense-ts/blob/6dc1604/src/input.ts#L8)
+
+___
+
+### threshold
+
+• `Optional` **threshold**: `number`
+
+#### Inherited from
+
+[InputParams](../wiki/InputParams).[threshold](../wiki/InputParams#threshold)
+
+#### Defined in
+
+[src/input.ts:7](https://github.com/nsfm/dualsense-ts/blob/6dc1604/src/input.ts#L7)
+
+___
+
+### trigger
+
+• `Optional` **trigger**: [`InputParams`](../wiki/InputParams)
+
+#### Defined in
+
+[src/elements/unisense.ts:8](https://github.com/nsfm/dualsense-ts/blob/6dc1604/src/elements/unisense.ts#L8)

package/docs/_Sidebar.md

@@ -0,0 +1,4 @@
+## dualsense-ts
+
+- [Home](../wiki/Home)
+- [Exports](../wiki/Exports)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dualsense-ts",
-  "version": "2.0.0",
+  "version": "2.0.3",
   "description": "A natural interface for your DualSense controller, with Typescript",
   "keywords": [
     "dualsense",
@@ -31,7 +31,7 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
-    "prebuild": "yarn barrels",
+    "prebuild": "yarn barrels && yarn docs",
     "build": "tsc --project tsconfig.build.json",
     "build:watch": "tsc --project tsconfig.build.json --pretty --watch",
     "lint": "eslint src",
@@ -42,6 +42,8 @@
     "coverage:watch": "jest src --coverage --verbose --watch",
     "barrels": "barrelsby -d src -D -l replace -e 'spec.ts$'",
     "barrels:watch": "nodemon yarn barrels",
+    "docs": "typedoc src/index.ts",
+    "docs:watch": "nodemon yarn docs",
     "debug": "nodemon -e ts,json --exec \"node --inspect --enable-source-maps --experimental-specifier-resolution=node --loader ts-node/esm ./util/debug.ts\""
   },
   "dependencies": {
@@ -62,6 +64,9 @@
     "prettier": "^2.3.2",
     "ts-jest": "^27.1.3",
     "ts-node": "^10.7.0",
+    "typedoc": "^0.22.15",
+    "typedoc-github-wiki-theme": "^1.0.1",
+    "typedoc-plugin-markdown": "^3.12.1",
     "typescript": "^4.6.4"
   },
   "eslintConfig": {

package/src/input.ts

@@ -113,10 +113,10 @@ export abstract class Input<Type>
     this.threshold = threshold;
     this.id = Symbol(this[InputName]);
 
-    this[InputSetComparison]();
+    this[InputChanged] = this[InputSetComparison]();
     setImmediate(() => {
       this[InputAdopt]();
-      this[InputSetComparison]();
+      this[InputChanged] = this[InputSetComparison]();
     });
   }
 
@@ -192,16 +192,16 @@ export abstract class Input<Type>
   }
 
   // Sets a default comparison type for the Input based on the generic type.
-  [InputSetComparison](): void {
+  [InputSetComparison](): (state: Type, newState: Type) => boolean {
     if (typeof this.state === "number") {
-      this[InputChanged] = this[InputChangedThreshold] as unknown as (
+      return this[InputChangedThreshold] as unknown as (
         state: Type,
         newState: Type
       ) => boolean;
     } else if (this.state instanceof Input) {
-      this[InputChanged] = this[InputChangedVirtual];
+      return this[InputChangedVirtual];
     } else {
-      this[InputChanged] = this[InputChangedPrimitive];
+      return this[InputChangedPrimitive];
     }
   }
 

package/tsconfig.json

@@ -27,5 +27,14 @@
     "transpileOnly": false,
     "files": true
   },
-  "lib": ["esnext"]
+  "lib": ["esnext"],
+  "typedocOptions": {
+    "name": "dualsense-ts",
+    "entryPoints": ["src/index.ts"],
+    "exclude": "**/**.spec.ts",
+    "excludePrivate": true,
+    "excludeProtected": true,
+    "excludeInternal": true,
+    "theme": "github-wiki"
+  }
 }