# clockface

> Animate the unicode clock faces, in the terminal

Latest version **1.1.1** (published 2016-02-26) · MIT license · 0 weekly downloads

## Install

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

Provides the command `clockface`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2016-02-26 |
| First published | 2016-02-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | David Mark Clements |
| Maintainers | davidmarkclements |

## Links

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

## Dependencies (1)

- [ansi-escapes](https://npm.io/package/ansi-escapes.md) ^1.1.1

## Recent versions

- 1.1.1 (latest) — 2016-02-26
- 1.1.0 — 2016-02-25
- 1.0.0 — 2016-02-25

## README

# clockface 🕘

Animate the unicode clock faces, in the terminal

```sh
var clock = require('clockface')({
  out: process.stdout, //default
  autostart: true, //default
  tick: 100, //default
})

process.stdout.write('yaaaaay ')

setTimeout(() => clock.pause(), 10000)
setTimeout(() => clock.start(), 15000)
setTimeout(() => clock.stop(), 25000)
```

## Spawning

If we're doing an intensive sync operation the
clockface won't animate (event loop blocked).

Mostly in a terminal app, these are the time's
we want to give user feedback. 

Clockface comes with an executable

```sh
clockface <tick> <autostart>
```

So the solution is to spawn with stdio inherit.

```js
  var clock = spawn(__dirname + '/node_modules/.bin/clockface', {stdio: 'inherit'})
```

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