console-gui-tools - npm Package Compare versions

Comparing version 1.1.16 to 1.1.21

DOCS.md

@@ -5,11 +5,1 @@ # DOCS
 
-* [ConsoleGui](docs/ConsoleGui.md)
-* [PageBuilder](docs/PageBuilder.md)
-* [Screen](docs/Screen.md)
-* [DoubleLayout](docs/DoubleLayout.md)
-* [ButtonPopup](docs/ButtonPopup.md)
-* [ConfirmPopup](docs/ConfirmPopup.md)
-* [CustomPopup](docs/CustomPopup.md)
-* [FileSelectorPopup](docs/FileSelectorPopup.md)
-* [InputPopup](docs/InputPopup.md)
-* [OptionPopup](docs/OptionPopup.md)

docs/ConsoleGui.md

@@ -17,5 +17,2 @@ ## Classes
 </dd>
-<dt><a href="#stdOut">stdOut</a> : <code>PageBuilder</code></dt>
-<dd><p>The logs page</p>
-</dd>
 <dt><a href="#homePage">homePage</a> : <code>Array.&lt;PageBuilder&gt;</code></dt>
@@ -27,2 +24,5 @@ <dd><p>The main application</p>
 </dd>
+<dt><a href="#stdOut">stdOut</a> : <code>PageBuilder</code></dt>
+<dd><p>The logs page</p>
+</dd>
 <dt><a href="#layout">layout</a> : <code>DoubleLayout</code></dt>
@@ -301,8 +301,2 @@ <dd><p>The layout instance</p>
 **Kind**: global constant  
-<a name="stdOut"></a>
-
-## stdOut : <code>PageBuilder</code>
-The logs page
-
-**Kind**: global constant  
 <a name="homePage"></a>
@@ -320,2 +314,8 @@
 **Kind**: global constant  
+<a name="stdOut"></a>
+
+## stdOut : <code>PageBuilder</code>
+The logs page
+
+**Kind**: global constant  
 <a name="layout"></a>
@@ -322,0 +322,0 @@

docs/PageBuilder.md

@@ -13,2 +13,3 @@ <a name="PageBuilder"></a>
         * [.getPageHeight()](#PageBuilder+getPageHeight) ⇒ <code>number</code>
+        * [.getViewedPageHeight()](#PageBuilder+getViewedPageHeight) ⇒ <code>number</code>
         * [.setScrollIndex(index)](#PageBuilder+setScrollIndex) ⇒ <code>void</code>
@@ -82,2 +83,12 @@ * [.setRowsPerPage(rowsPerPage)](#PageBuilder+setRowsPerPage) ⇒ <code>void</code>
 ```
+<a name="PageBuilder+getViewedPageHeight"></a>
+
+### pageBuilder.getViewedPageHeight() ⇒ <code>number</code>
+Returns the height of the viewed page. It excludes the rows that are not visible.
+
+**Kind**: instance method of [<code>PageBuilder</code>](#PageBuilder)  
+**Example**  
+```js
+page.getViewedPageHeight() // returns the height of the page that is visible
+```
 <a name="PageBuilder+setScrollIndex"></a>
@@ -84,0 +95,0 @@

jsdoc2md.json

@@ -0,0 +0,0 @@ {

package.json

 {
     "name": "console-gui-tools",
-    "version": "1.1.16",
+    "version": "1.1.21",
     "description": "A simple library to draw option menu, text popup or other widgets and layout on a Node.js console.",
-    "main": "src/ConsoleGui.js",
+    "main": "dist/ConsoleGui.js",
+    "typings": "dist/ConsoleGui.d.ts",
+    "types": "dist/ConsoleGui.d.ts",
     "type": "module",
     "scripts": {
-        "test": "node ./examples/tcp_simulator.mjs",
-        "start": "node src/ConsoleGui.js",
+        "lint": "eslint ./src/ --ext .ts",
+        "build": "tsc",
+        "prepare": "npm run build",
+        "test": "npm run build && node ./examples/tcp_simulator.mjs",
+        "start": "npm run build && node ./dist/ConsoqleGui.js",
         "docsgen": "node ./docgen.cjs"
@@ -38,5 +43,9 @@ },
     "devDependencies": {
+        "@types/node": "^17.0.35",
+        "@typescript-eslint/eslint-plugin": "^5.25.0",
+        "@typescript-eslint/parser": "^5.25.0",
         "eslint": "^8.15.0",
-        "jsdoc-to-markdown": "^7.1.1"
+        "jsdoc-to-markdown": "^7.1.1",
+        "typescript": "^4.6.4"
     }
-}
+}

README.md

@@ -0,0 +0,0 @@ # console-gui-tools

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

448602

129.72%

Number of package files

62

87.88%

Lines of code

6686

150.79%

Worsened metrics

Dev dependency count

6

200%

Number of medium supply chain risk alerts

2

100%

No dependency changes