Skip to content

Commit

Permalink
🦄: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
whizkydee committed Aug 21, 2018
1 parent a1b9897 commit f117d21
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ reverse(set); //=> Set { 3, 4, 5 }

## options

`options` is the second parameter to the function call and it is an object with two available properties...
`options` is the second parameter to the function call and it is an object with two available properties. It can also take in a falsy value which would implicity get converted to an empty object.

### `invert: {String}`

Expand Down Expand Up @@ -120,7 +120,7 @@ reverse(/*...*/, {

### `preserveZeros: {Boolean}`

This property defaults to `false`. It specifies whether to enforce preceding zeros in the result of a number that contains trailing zeros. See [#3](https://github.com/whizkydee/type-reverse/issues/4) for more info.
This property defaults to `false`. It specifies whether to enforce preceding zeros in the result of a number that contains trailing zeros. See [#3](https://github.com/whizkydee/type-reverse/issues/4) for more info. Note that the result gets converted to a string.

```js
reverse(240, { preserveZeros: true }); //=> "042"
Expand Down

0 comments on commit f117d21

Please sign in to comment.