0.0.3 • Published 8 years ago
terminal-cursor v0.0.3
Terminal Cursor 
Manipulate the terminal cursor (move, hide, show, etc)
Install
$ npm install --save terminal-cursor Usage
var Cursor = require("terminal-cursor")
var cursor = new Cursor(0, 0)
cursor.move("down", 2)
console.log("Hello")
cursor.move("down", 4)
console.log("World")Test
$ npm testAPI
new Cursor(xPos, yPos)
Creates an instance of Cursor at a given position
| Name | Type | Description |
|---|---|---|
| xPos | Number | x coordinate of the cursor you are creating |
| yPos | Number | y coordinate of the cursor you are creating |
Returns a Cursor instance
var Cursor = require("terminal-cursor")
var cursor = new Cursor(0, 0)
cursor.move("down", 2)
console.log("Hello")
cursor.move("down", 4)
console.log("World")move(type, count)
Moves the cursor in a given position
| Name | Type | Description |
|---|---|---|
| type | String | Type of movement: "up", "down", "right", "left" |
| count | Number | How many times should the cursor move. |
var Cursor = require("terminal-cursor")
var cursor = new Cursor(0, 0)
cursor.move("down", 2)
console.log("Hello")
cursor.move("down", 4)
console.log("World")movePos(xPos, yPos)
Moves the cursor to a given coordinate
| Name | Type | Description |
|---|---|---|
| xPos | Number | The x coordinate where you want to move the cursor. |
| yPos | Number | The y coordinate where you want to move the cursor. |
var Cursor = require("terminal-cursor")
var cursor = new Cursor(0, 0)
cursor.movePos(5, 10)
console.log("Hello")show()
Displays the cursor
hide()
Hides the cursor
License
MIT © Joe Gesualdo