# termbox

> termbox bindings for node.js

Latest version **0.1.0** (published 2013-07-27) · custom license · 0 weekly downloads

## Install

```sh
npm install termbox
pnpm add termbox
yarn add termbox
bun add termbox
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2013-07-27 |
| First published | 2013-07-27 |
| Weekly downloads | 0 |
| License | custom |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.1.0 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| Author | Josh Klar |
| Maintainers | iv597 |

## Links

- npm: https://www.npmjs.com/package/termbox
- npm.io page: https://npm.io/package/termbox

## Recent versions

- 0.1.0 (latest) — 2013-07-27

## README

node-termbox
============

Some simple bindings of [termbox](http://github.com/nsf/termbox) to
node.js. Not perfect at all, and I'm sure there's bugs somewhere, but
for a one-nighter it worked out pretty well. I seem to be able to do
anything I would need to (time will tell). Bug reports welcome.

FUNCTIONS
---------

    init() -> [Number]
    shutdown() -> [Number] -- Always 0
    width() -> [Number]
    height() -> [Number]
    clear() -> [Number] -- Always 0
    present() -> [Number] -- Always 0
    setCursor(x, y) [Number], [Number] -> [Number] -- Always 0
    hideCursor() -> [Number] -- Always 0
    changeCell(x, y, char, fg, bg) [Number], [Number], [String], [Number], [Number] -> [Number] -- Always 0
    selectInputMode(mode) [Number] -> [Number]
    setClearAttributes(fg, bg) [Number], [Number]
    peekEvent(timeout) [Number] (milliseconds) -> [Object] -- type, mod, key, ch, w, h
    pollEvent() -> [Object] -- type, mod, key, ch, w, h

CONSTANTS
---------

I'll spare you the detail of *every single one* of these, as it's a
massive list. I expose everything defined in termbox.h, so go to town.

LICENSE
-------

    Copyright (c) 2013 Josh Klar <j@iv597.com>
    
    Do whatever you want with this code as long as you leave this header.
    This code has no warranty. If shit hits the fan, it's your problem.

---
_Source: https://npm.io/package/termbox · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._