# urlon

> URL Object Notation. JSON-like encoding for URLs

Latest version **3.1.0** (published 2021-04-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install urlon
pnpm add urlon
yarn add urlon
bun add urlon
```

## 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 | 3.1.0 |
| Published | 2021-04-18 |
| First published | 2015-11-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 10.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 127 |
| Author | Vjeux |
| Maintainers | vjeux, guria, cerebral.js |
| Keywords | urlon, json, notation, url |

## Links

- npm: https://www.npmjs.com/package/urlon
- Repository: https://github.com/cerebral/urlon
- Issues: https://github.com/cerebral/urlon/issues
- npm.io page: https://npm.io/package/urlon

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 3.1.0 (latest) — 2021-04-18
- 3.1.0-alpha.1 (alpha) — 2021-04-18
- 3.0.1 — 2017-11-14
- 3.0.0 — 2017-11-14
- 2.1.0 — 2017-11-03
- 2.0.1 — 2016-04-07
- 2.0.0 — 2015-11-21

## README

# URL Object Notation

An Object Notation like JSON but for URLs.
Read the full explanation on @vjeux blog:
http://blog.vjeux.com/2011/javascript/urlon-url-object-notation.html

Note that format is slightly changed since article was published, but main idea remains the same.

## Getting started
### NPM
URLON is on [NPM](http://search.npmjs.org/#/urlon).

```sh
npm install urlon
```
```javascript
var URLON = require('urlon');
```

### UMD build using `<script>`
```html
<script src="https://unpkg.com/urlon/dist/urlon.umd.js"></script>
<script>
  urlon // urlon.stringify() or urlon.parse()
</script>
```

## Usage

### stringify

```javascript
URLON.stringify({"table":{"achievement":{"column":"instance","ascending":true}}})

// Output:      '$table$achievement$column=instance&ascending:true'
```

### parse

```javascript
URLON.parse('$table$achievement$column=instance&ascending:true')

// Output:  {"table":{"achievement":{"column":"instance","ascending":true}}}
```

## Projects using URLON

* [url-mapper](https://github.com/cerebral/url-mapper) - `@cerebral/router` default mapper for URLs

## Changelog

See [releases](https://github.com/cerebral/urlon/releases)

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