Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #158

Merged
merged 2 commits into from
Sep 21, 2018
Merged

Update README.md #158

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3ca7ab0
Update README.md
niftylettuce Sep 21, 2018
a1fadd2
Update README.md
niftylettuce Sep 21, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,14 @@ All examples assume that this library is bootstrapped using:
```js
'use strict';

var URL = require('url-parse');
var Url = require('url-parse');
```

To parse an URL simply call the `URL` method with the URL that needs to be
transformed into an object.

```js
var url = new URL('https://github.com/foo/bar');
var url = new Url('https://github.com/foo/bar');
```

The `new` keyword is optional but it will save you an extra function invocation.
Expand Down Expand Up @@ -100,7 +100,7 @@ var parse = require('url-parse');
parse('hostname', {});
```

### URL.set(key, value)
### Url.set(key, value)

A simple helper function to change parts of the URL and propagating it through
all properties. When you set a new `host` you want the same value to be applied
Expand All @@ -117,7 +117,7 @@ console.log(parsed.href); // http://yahoo.com/parse-things
It's aware of default ports so you cannot set a port 80 on an URL which has
`http` as protocol.

### URL.toString()
### Url.toString()

The returned `url` object comes with a custom `toString` method which will
generate a full URL again when called. The method accepts an extra function
Expand Down