# string-prototype-dyslexia

> A useless package to add some fun in your syntaxe!

Latest version **1.0.4** (published 2018-09-21) · ISC license · 0 weekly downloads

## Install

```sh
npm install string-prototype-dyslexia
pnpm add string-prototype-dyslexia
yarn add string-prototype-dyslexia
bun add string-prototype-dyslexia
```

## 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.0.4 |
| Published | 2018-09-21 |
| First published | 2018-09-21 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 2.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Benoit Ripoche |
| Maintainers | pochwar |

## Links

- npm: https://www.npmjs.com/package/string-prototype-dyslexia
- Repository: https://github.com/Pochwar/dyslexia
- Homepage: https://github.com/Pochwar/dyslexia#readme
- Issues: https://github.com/Pochwar/dyslexia/issues
- npm.io page: https://npm.io/package/string-prototype-dyslexia

## Recent versions

- 1.0.4 (latest) — 2018-09-21
- 1.0.3 — 2018-09-21
- 1.0.2 — 2018-09-21
- 1.0.1 — 2018-09-21
- 1.0.0 — 2018-09-21

## README

# String Prototype Dyslexia

A useless package to add some fun in your syntaxe!

## Installation

`npm install string-prototype-dyslexia`

## Implementation

### Back
- Require package with `require('string-prototype-dyslexia')`

### Front
- Include package with `<script>` tag: `<script src="node_modules/string-prototype-dyslexia/String.prototype.dyslexia.js"></script>`

## Usage

- Use `dyslexia()` method on any string

```
var my_string = "Hello dyslexia"
console.log(my_string.dyslexia()) // display something like "Hlelo dylsexia"
```

## Options

### Proba
- Description: the probability for a word in the string to be "dyslexied".
- Type : integer
- Default value: `0`
- Possible values: `0` to infinite
    - `0`: high probability for the word to be "dyslexied"
    - `5` or more: low probability for the word to be "dyslexied"
- Usage: `my_string.dyslexia(2)`

## Demo
https://pochwar.github.io/dyslexia/demo/

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