Skip to content
compute the relative cursor position on a terminal stream
JavaScript
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
test
.travis.yml
README.markdown
index.js
package.json

README.markdown

cursory

Compute the relative cursor position from a stream that emits ansi events.

build status

status

Escape codes that set absolute coordinates are not yet supported.

methods

var cursory = require('cursory');

var pos = cursory(width)

Return a new writable stream pos from an optional window width.

pos has attributes that update and events that fire as the screen position state of the input stream changes.

attributes

pos.x

The current cursor position's relative x coordinate (column)

pos.y

The current cursor position's relative y coordinate (row)

events

'pos', x, y

Emitted when the cursor position updates.

install

npm install cursory

license

MIT

Something went wrong with that request. Please try again.