# @nerdos/typewriter

> ```sh $ yarn add typewriter

Latest version **0.0.9** (published 2022-08-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install @nerdos/typewriter
pnpm add @nerdos/typewriter
yarn add @nerdos/typewriter
bun add @nerdos/typewriter
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.9 |
| Published | 2022-08-10 |
| First published | 2022-08-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 28.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Captain Martin |
| Maintainers | captainmartin |

## Links

- npm: https://www.npmjs.com/package/@nerdos/typewriter
- Repository: https://github.com/captain-martin/Typewriter
- Homepage: https://github.com/captain-martin/typewriter#readme
- Issues: https://github.com/captain-martin/Typewriter/issues
- npm.io page: https://npm.io/package/@nerdos/typewriter

## Dependencies (1)

- [nodemon](https://npm.io/package/nodemon.md) ^2.0.19

## Recent versions

- 0.0.9 (latest) — 2022-08-10

## README

# Typewriter - WIP

```sh
$ yarn add typewriter

# or

$ pnpm install typewriter
```

## Example

```ts
import Typewriter from "./dist/index.mjs";
(async () => {
  const typewriter = new Typewriter({
    containerId: "output",
    // cursorBG: '#ee30a1',
  });
  await typewriter.sleep(2000);
  await typewriter.typingFunction();
  await typewriter.typing(" ");
  await typewriter.typingFunctionName("beepInterval");
  await typewriter.typing("() ");
  await typewriter.typingBlock("{}");
  await typewriter.sleep(1800);
  await typewriter.typingEnter();
  await typewriter.sleep(500);
  await typewriter.typingComment("// function ");
  await typewriter.typingComment(["comes here", "detail..."]);
  await typewriter.sleep(1500);
  await typewriter.newLine(1);
  await typewriter.sleep(1200);
  await typewriter.typingFunction("return ");
  await typewriter.typingFunctionName("setInterval");
  await typewriter.typingBlock("()");
  await typewriter.sleep(1200);
  await typewriter.typing("() => ");
  await typewriter.typingBlock("{}");
  await typewriter.sleep(800);
  await typewriter.typingEnter(1);
  await typewriter.typingFunction("if ");
  await typewriter.typingBlock("()");
  await typewriter.typingFunctionName("this");
  await typewriter.typing(".");
  await typewriter.typingVariable("cursorElement");
  await typewriter.relocateCursor();
  await typewriter.typing(" ");
  await typewriter.typingBlock("{}");
  await typewriter.sleep(1200);
  await typewriter.typingEnter(2);
  await typewriter.typingFunction("const ");
  await typewriter.typingBlock("{}");
  await typewriter.typingVariable(" visibility ");
  await typewriter.relocateCursor();
  await typewriter.typingFunction(" = ");
  await typewriter.typingFunctionName("this");
  await typewriter.typing(".");
  await typewriter.typingVariable("cursorElement");
  await typewriter.typing(".");
  await typewriter.typingVariable("style");
  await typewriter.sleep(1200);
  await typewriter.newLine(3);
  await typewriter.typingComment("// More detail...");
})();
```

## License

[MIT](./LICENSE) License © 2022 [Captain Martin](https://github.com/captain-martin)

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