https://github.com/hackwaly/urism

Convert your JS object from/to human readable URI
https://github.com/hackwaly/urism

cyclic-references format querystring uri uri-query

Last synced: 6 days ago
JSON representation

Convert your JS object from/to human readable URI

• Host: GitHub
• URL: https://github.com/hackwaly/urism
• Owner: hackwaly
• Created: 2019-10-10T07:29:29.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-03-03T08:29:38.000Z (almost 2 years ago)
• Last Synced: 2024-11-30T05:11:58.877Z (24 days ago)
• Topics: cyclic-references, format, querystring, uri, uri-query
• Language: JavaScript
• Size: 521 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# urism

Convert your JS object from/to human readable URI.

[![Build Status](https://travis-ci.com/hackwaly/urism.svg?token=pxqyFKtvSJ5zppZXXVbG&branch=master)](https://travis-ci.com/hackwaly/urism)

## Example

TO DO

## Why

* You want put arbitrary complex json data to querystring, but you find none of existing libraries support it. They do not support booleans, and can't distinguish numbers and strings, or can't represent specific values, such as null, undefined, NaN, Infinity and cyclic references.

* You want your querystring is human readable, and you don't want to pack your data to base64 or other formats.

* You want your querystring is safe for browsers and servers, and spec compliant. Most formats using brackets for array and object. It's unsafe.

* You want your values keep their literal as close as possible, so you can copy it from browser's location bar and paste to other places without addition modifications.

## How

* Specific values encoded to aliases. `true` -> `"$true"`, `null` -> `"$null"`, `NaN` -> `"$nan"` ...

* Reserved characters and non-ascii characters encoded to percent escaped sequence. `"#"` -> `"%23"`, `" "` -> `"%20"`, `"你好"` -> `"%E4%BD%A0%E5%A5%BD"`

* Number(s) keep their literal except specific values `NaN`, `Infinity`, `-Infinity`. Numbers will encoded to exponential format if it's shorter.

* String(s) will encoded in raw mode if ambiguity. Eg. It looks like number, array, object or alias. Raw mode start with marker `"?"`. End with marker `"?"`. `"1-2-3"` -> `"1-2-3"`, `"123"` -> `"?123?"`.

* Object(s) except root object start with marker `"+"`. `{a:1, b:2}` -> `"+a=1&b=2;"`

* Boolean(s) and undefined(s) as object property have syntax sugar. `{a: true, b: undefined, c: false}` -> `"+a&-b;"`.

* Array(s) start with marker `":"`. End with marker `";"`. `[1,2,3]` -> `":1,2,3;"`.

* Cyclic references encoded to aliases. `var a = {}; a.a = a; a` -> `"0$+a=$0;"`.

* Date(s) and RegExp(s) encoded to call form of alias. `new Date(2019, 10, 11)` -> `"$date:2019-11-11+08;"`.

* Root object do not have start/end markers and prefixed with `"?"`. `{a: 1}` -> `"?a=1"`

* End markers except call form can omit if no ambiguity like HTML end tag.

* For more details, please see code.

## Contribution

Buy me a coffee if this library save your time.

### Things to Contribute

* Refine README and example.

* Proposal new rules or improvement on existing rules.

* Fix bugs and add tests.