ki9
/
mocha-froth
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Rewrote readme

master
Keith Irwin 2018-02-24 23:58:41 +00:00
parent c385772225
commit 8fc9c39c3f
No known key found for this signature in database
GPG Key ID: 378933C743E2BBC0
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -1,12 +1,10 @@
# mocha-froth # mocha-froth
###### v0.2.2
[Keith Irwin](https://keithirwin.us/)
[![Build Status](https://travis-ci.org/keith24/mocha-froth.svg?branch=master)](https://travis-ci.org/keith24/mocha-froth) [![Build Status](https://travis-ci.org/keith24/mocha-froth.svg?branch=master)](https://travis-ci.org/keith24/mocha-froth)
[![Coverage Status](https://coveralls.io/repos/github/keith24/mocha-froth/badge.svg?branch=master)](https://coveralls.io/github/keith24/mocha-froth?branch=master) [![Coverage Status](https://coveralls.io/repos/github/keith24/mocha-froth/badge.svg?branch=master)](https://coveralls.io/github/keith24/mocha-froth?branch=master)
Fuzzer for mocha testing. Or any javascript testing suite, really. This package provides a function that returns an array of random strings. You know, a [fuzzer](https://en.wikipedia.org/wiki/Fuzzer). Fuzzer for mocha testing. Or any javascript testing suite, really. This package provides a function that returns an array of random strings. You know, a [fuzzer](https://en.wikipedia.org/wiki/Fuzzer).
## Installation ## Installation
```sh ```sh
@ -41,6 +39,9 @@ opt = {
} }
``` ```
mocha-froth will return an array of strings you can use to test your code.
### Examples ### Examples
Create ten random strings, each up to twenty characters (default): Create ten random strings, each up to twenty characters (default):
@ -58,11 +59,13 @@ console.log( froth(5,10) )
``` ```
Same as above, but without foreign characters: Same as above, but without foreign characters:
```javascript ```javascript
console.log( froth(5,10,{foreign:false}) ) console.log( froth(5,10,{foreign:false}) )
// [ 'VP"""t¬mK²', '²L6)>\r\nV', 'v,→“', '*e8', '→' ] // [ 'VP"""t¬mK²', '²L6)>\r\nV', 'v,→“', '*e8', '→' ]
``` ```
## Testing ## Testing
```sh ```sh