# @j0nz/decoder-text

> ## Installation ```sh yarn add @j0nz/decoder-text ```

Latest version **0.2.0** (published 2018-10-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install @j0nz/decoder-text
pnpm add @j0nz/decoder-text
yarn add @j0nz/decoder-text
bun add @j0nz/decoder-text
```

## 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.2.0 |
| Published | 2018-10-05 |
| First published | 2018-10-03 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 257.2 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Reed Jones |
| Maintainers | reed-jones |

## Links

- npm: https://www.npmjs.com/package/@j0nz/decoder-text
- Repository: https://github.com/reed-jones/decoder-text
- Homepage: https://github.com/reed-jones/decoder-text#readme
- Issues: https://github.com/reed-jones/decoder-text/issues
- npm.io page: https://npm.io/package/@j0nz/decoder-text

## Dependencies (1)

- [vue](https://npm.io/package/vue.md) ^2.5.17

## Recent versions

- 0.2.0 (latest) — 2018-10-05
- 0.1.1 — 2018-10-03
- 0.1.0 — 2018-10-03

## README

# decoder-text

## Installation
```sh
yarn add @j0nz/decoder-text
```

### Setup
```js
import DecoderText from '@j0nz/decoder-text'
Vue.use(DecoderText)
```

### Example
```html
<decoder-text
  v-model='model'
  :target='text'
  :fps='24'
  :resetWord='false'
  :steps='4'
  @start='startFunc'
  @end='endFunc'
  @abort='cancelFunc'
/>
```

| Prop | Type | Description |
| -- | -- | -- |
| target | string | Desired end state after decoding is complete |
| value | string | Current state of text. (is all jumbled up during decoding) |
| fps | number | frames per second (how fast to switch characters) |
| steps | number | how many letters are jumbled at any given time |
| resetWord | boolean | reset between target changes (or not) |

| Events | Returns | Description |
| -- | -- | -- |
| start | returns the word that was started | Occurs when a new word is started |
| end | returns the word that finished | Occurs when a word finishes |
| abort | returns two params, the cancelled word and the newly started word | Occurs when a new word is started before the old word finishes |

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