Skip to content

Commit

Permalink
added headers in usage section
Browse files Browse the repository at this point in the history
  • Loading branch information
mankal111 committed Feb 11, 2019
1 parent 1a6e33f commit 8b6b656
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Javascript eXtended Random number generator
var JXRand = require('JXRand');
```

### getNumber
To get a random integer between 10 and 20:

```js
Expand All @@ -21,6 +22,7 @@ To get a random integer between 10 and 20:
The `type` property is optional with a default value of `float`.
For now the supported types are `integer` and `float`.

### getInterval
To get a random interval, with integer endpoints between 0 and 100 and length between 10 and 50:

```js
Expand All @@ -37,6 +39,7 @@ A possible value of `randomInterval` is `[43, 75]`.

The `minLength`, `maxLength` and `type` properties are optional.

### getElement
To get a random element from a given array:

```js
Expand All @@ -45,6 +48,7 @@ To get a random element from a given array:

The `randomElement` should now contain one random element of the array.

### getRandomValuesObject
In case we want to create an object with random values in custom keys, we can use `getRandomValuesObject`.

We are using an array of objects as an argument where each object should contain the `name` of the key and the `type` of the random value.
Expand Down

0 comments on commit 8b6b656

Please sign in to comment.