# retrotext

> API Bindings for the Retro Text Generator

Latest version **4.0.1** (published 2020-03-14) · ISC license · 0 weekly downloads

## Install

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

## Health

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

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

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.1 |
| Published | 2020-03-14 |
| First published | 2016-10-11 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 14.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jack Baron |
| Maintainers | lolpants |

## Links

- npm: https://www.npmjs.com/package/retrotext
- Repository: git@github.com:lolPants/retrotext
- npm.io page: https://npm.io/package/retrotext

## Dependencies (3)

- [cheerio](https://npm.io/package/cheerio.md) ^1.0.0-rc.3
- [isomorphic-unfetch](https://npm.io/package/isomorphic-unfetch.md) ^3.0.0
- [isomorphic-form-data](https://npm.io/package/isomorphic-form-data.md) ^2.0.0

## Recent versions

- 4.0.1 (latest) — 2020-03-14
- 4.0.0 — 2020-03-14
- 3.1.1 — 2019-07-11
- 3.1.0 — 2019-02-10
- 3.0.1 — 2018-10-13
- 3.0.0 — 2018-08-20
- 2.1.2 — 2017-11-02
- 2.1.1 — 2017-10-13
- 2.1.0 — 2017-09-17
- 2.0.0 — 2017-08-17
- 1.4.2 — 2016-12-22
- 1.4.1 — 2016-12-02
- 1.3.1 — 2016-11-09
- 1.3.0 — 2016-11-09
- 1.2.0 — 2016-11-03
- … 4 more at https://npm.io/package/retrotext/versions

## README

# 📼 Retro Text
[![NPM version](https://img.shields.io/npm/v/retrotext.svg?maxAge=3600)](https://www.npmjs.com/package/retrotext)
[![NPM downloads](https://img.shields.io/npm/dt/retrotext.svg?maxAge=3600)](https://www.npmjs.com/package/retrotext)
[![Build status](https://travis-ci.org/lolPants/retrotext.svg)](https://travis-ci.org/lolPants/retrotext)
[![Dependencies](https://img.shields.io/david/lolpants/retrotext.svg?maxAge=3600)](https://david-dm.org/lolpants/retrotext)

_Generate retro style text images using the [PhotoFunia API](https://photofunia.com/)_

## 💾 Installation
The package is on the NPM registry as `retrotext`. Simply install it with your NPM client of choice.

## ❓ Compatibility
This module can be used in both the browser and Node.js. It targets ES2015 and newer.

## 🔧 Usage
First, import the module:
```js
const RetroText = require('retrotext')
const { TextStyle, BackgroundStyle } = RetroText
```

`RetroText` is an ES6 class that can be manipulated to generate Retro Text images.

### 📝 Example
```js
// Import the module
const RetroText = require('retrotext')
const { TextStyle, BackgroundStyle } = RetroText

// Set options
const text = new RetroText()
  .setLine1('Top')
  .setLine2('Middle')
  .setLine3('Bottom')
  .setBackgroundStyle(BackgroundStyle.PALM_CIRCLE)
  .setTextStyle(TextStyle.CHROME)

// Generate using API
let URL = await text.fetchURL()
let buffer = await text.fetchBuffer()
```

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