# simple-url-fix

> simple utilities of url

Latest version **1.2.1** (published 2018-01-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install simple-url-fix
pnpm add simple-url-fix
yarn add simple-url-fix
bun add simple-url-fix
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.1 |
| Published | 2018-01-05 |
| First published | 2018-01-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jimmy-YMJ |
| Maintainers | youthink |
| Keywords | url parser, url composer |

## Links

- npm: https://www.npmjs.com/package/simple-url-fix
- Repository: https://github.com/Jimmy-YMJ/simple-url
- Homepage: https://github.com/Jimmy-YMJ/simple-url#readme
- Issues: https://github.com/Jimmy-YMJ/simple-url/issues
- npm.io page: https://npm.io/package/simple-url-fix

## Dependencies (1)

- [qs](https://npm.io/package/qs.md) ^6.3.0

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 1.2.1 (latest) — 2018-01-05
- 1.2.0 — 2018-01-03
- 1.1.9 — 2018-01-03

## README

# simple-url
**simple-url** is a lib of utilities for url which can be used in both browser and node.js.

## Installing
Use via npm:
```bash
npm install simple-url
```
```javascript
var url = require('simple-url');

// Use es6 import
import url from 'simple-url';
```
Use in browser:

Scripts for browser is under [build](https://github.com/Jimmy-YMJ/simple-url/tree/master/build) directory, use `url.js` for development (contains inline source maps) or use `url.min.js` for production. The reference in browser is `window.simpleUrl`.

## The structure of a url
The following illustration comes from [nodejs docs](https://nodejs.org/api/url.html).
```
┌─────────────────────────────────────────────────────────────────────────────┐
│                                    href                                     │
├──────────┬┬───────────┬─────────────────┬───────────────────────────┬───────┤
│ protocol ││   auth    │      host       │           path            │ hash  │
│          ││           ├──────────┬──────┼──────────┬────────────────┤       │
│          ││           │ hostname │ port │ pathname │     search     │       │
│          ││           │          │      │          ├─┬──────────────┤       │
│          ││           │          │      │          │ │    query     │       │
"  http:   // user:pass @ host.com : 8080   /p/a/t/h  ?  query=string   #hash "
│          ││           │          │      │          │ │              │       │
└──────────┴┴───────────┴──────────┴──────┴──────────┴─┴──────────────┴───────┘
(all spaces in the "" line should be ignored -- they are purely for formatting)
```

## Examples

Parse a url:
```javascript
var simpleUrl = require('simple-url');

var parsedUrl = simpleUrl.parse('http://foo.com/pathname/?foo=bar', true);
console.log(parsedUrl);
/**
* The output is:
* {
*   protocol: 'http',
*   auth: '',
*   host: 'foo.com',
*   pathname: '/pathname/',
*   query: {foo: 'bar'},
*   hash: ''
* }
*/
```

Trim origin:
```javascript
var simpleUrl = require('simple-url');

console.log(simpleUrl.trimOrigin('http://foo.com/pathname/?foo=bar'));
// Output: /pathname/?foo=bar

console.log(simpleUrl.trimOrigin(/pathname/?foo=bar));
// Output: /pathanem/?foo=bar

```

Create a url:
```javascript
var simpleUrl = require('simple-url');

var url = simpleUrl.create({
    protocol: 'https',
    host: 'github.com',
    query: {colors: ['red', 'green', 'blue']}
  });
console.log(url);
/**
* The output is:
* https://github.com/?colors%5B0%5D=red&colors%5B1%5D=green&colors%5B2%5D=blue
*/
```

Create a path:
```javascript
var path1 = simpleUrl.createPath(
    '/foo/bar',
    {colors: ['red', 'green', 'blue']}
  );
console.log(path);
/*
* The output is:
* /foo/bar?colors%5B0%5D=red&colors%5B1%5D=green&colors%5B2%5D=blue
*/

var path2 = simpleUrl.createPath({
    pathname: '/foo/bar',
    query: {colors: ['red', 'green', 'blue']}
  });
console.log(path1 === path2)
/**
* The output is:
* true
*/
```

## methods
### url.parse(url, parseQuery)

| **Params** | **Type** | **Description** |
| --- | --- | --- |
| url | `String` |  Url to parse. |
| parseQuery | `Boolean` | QueryString will be parsed if it's `true`, default `false` |

This method parses the given `url` and returns `null`(invalid url) or `object` like:
```javascript
{
  protocol: 'http', // '' if mismatch
  auth: 'user:pass', // '' if mismatch
  host: 'host.com:8080', // '' if mismatch
  pathname: '/p/a/t/h', // '' if mismatch
  query: {foo: 'bar'}, // {} if mismatch
  hash: 'hash' // '' if mismatch
}
```
__Note:__ `url` for **url.parse** is not necessary to be a complete url, it can be `//host.com : 8080/path?query=string#hash`, `/path?query=string`, etc.


### url.create(options)

This method creates a url with the given options.

| **Options** | **Type** | **Default** |
| --- | --- | --- |
| protocal | `String` | 'http' |
| auth | `String` | '' |
| host |  `String` | 'localhost' |
| pathname | `String` | '/' |
| query |  `String` or `Obj` | '' |
| hash |  `String` | '' |

None of these options is required, it will produce a `"http://localhost"` if you call `url.create()` only.


### url.createPath(pathname, query, hash) or url.createPath(options)

This method simply crates a path and it's params have the same defaults with **url.create**'s. It leaves param `hash` there for convenience though it is not a part of path.


### url.trimOrigin(url)

This method will trim origin of the given url, and it will not decode any uri component or query.


### url.qs

This is exactly a reference to [qs](https://github.com/ljharb/qs), which is the only dependency of **simple-url**. It is exposed just for convenience.

## License
MIT

---
_Source: https://npm.io/package/simple-url-fix · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._