Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vitaly-t committed Jul 17, 2018
1 parent c453ccc commit 9727666
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ a.hosts[0].toString(); //=> 'my-host:123'
a.hosts[1].toString(); //=> '[abcd::]:456'
```

The method takes one optional parameter - the URL encoding options, which currently supports only `encodeDollar` flag.
The method takes one optional parameter - URL encoding options, which currently supports only `encodeDollar` flag.

By default, `$` is not URL-encoded, as it is not used often, and even when it is used, it is usually either in the password
or a parameter name, where encoding is typically not needed. But if you do need `$` encoded (into `%24`), pass in options
Expand Down

0 comments on commit 9727666

Please sign in to comment.