query-pack
v0.3.1
Published
Encode or decode query parameter
Downloads
63
Maintainers
Readme
query-pack
Encode - Decode Query Parameter
Usage
Installation:
npm install query-pack
String example
Encodes string value:
import { encode } from 'query-pack';
...
const qParam = encode('Hey, how are you?')
const url = `https://mydomain.com?q=${qParam}`;
console.log(url);
// => https://mydomain.com?q=UheyCWhowWareWyouQ
Decodes string value:
import { decode } from 'query-pack';
...
let params = (new URL(document.location)).searchParams;
let qParam = params.get("q");
const value = decode(qParam);
console.log(value);
// => Hey, how are you?
Object example
Encodes object value:
import { encode } from 'query-pack';
...
const qParam = encode({
id: 1,
name: "Team 1",
captain: "zak",
})
const url = `https://mydomain.com?q=${qParam}`;
console.log(url);
// => https://mydomain.com?q=1XidN1YnameSUteamW1YcaptainSzak
Decodes object value:
import { decode } from 'query-pack';
...
let params = (new URL(document.location)).searchParams;
let qParam = params.get("q");
const value = decode(qParam);
console.log(value);
// => {
// id: 1,
// name: "Team 1",
// captain: "zak",
// }
Options
Options is an encoding settings passed as a second parameter to the encode
or decode
functions. Has PackOptions
type.
| Name | Description |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| fields | Replaces the names of the object's fields into numbers in order to make encoded result shorter. Example of using fields optimization |
| values | Replaces the values of the object's field into numbers or short strings in order to make encoded result shorter. Example of using values optimization |
| includeUndefinedProperty | Indicates if property of object with undefined
value must be included into encoded result. Default value is false
|
Fields Optimization
Here we have a team object. Its field's names are replaced with numbers (id
=> 1, ...). Since numbers are shorter and as result we will have shorter encoded result.
import { encode, decode, PackOptions } from 'query-pack';
...
const packOptions: PackOptions = {
fields:{
id: 1,
name: 2,
captain: 3
}
}
...
const qParam = encode({
id: 1,
name: "Team 1",
captain: "zak",
}, packOptions);
console.log(qParam);
// => 1X1N1Y2SUteamW1Y3Szak
const team = decode(qParam, packOptions);
console.log(team);
// => {
// id: 1,
// name: "Team 1",
// captain: "zak",
// }
Values Optimization
Here we have a player object with level
field. Possible values for it are strings: unknown
, notbad
, normal
, good
, star
. We replacing them with numbers. In our case the player object has good
level value. So while encoding it would receive value of 4
. This makes encoded result shorter.
import { encode, decode, PackOptions } from 'query-pack';
...
const packOptions: PackOptions = {
values:{
level: {
unknown: 1,
notbad: 2,
normal: 3,
good: 4,
star: 5,
},
}
}
...
const qParam = encode({
name: "zak",
level: "good",
}, packOptions);
console.log(qParam);
// => 1XnameSzakYlevelS4
const team = decode(qParam, packOptions);
console.log(team);
// => {
// name: "zak",
// level: "good",
// }
Philosophy
The maximum length of URL is 2048 characters. This is enough space for encoding data for small or medium page. What's more, in this case you don't need to have database or API.
There is and example of using query-pack
. This is the tournament team constructor witch generates the tournament data into URL's query parameter. That's it, no API or database the tournament data is stored into the URL. This link has 512 chars and this is enough for encoding information about 4 teams and 24 players, games between teams, scheduel and results.
Base
query-pack
encodesstring
, number
, boolean
, array
, object
values into a string for using it in URL's query paramter.
This is kind of alternative of using encodeURIComponent
and decodeURIComponent
, but with differences. The primitive types like string
, number
, and boolean
query-pack
makes shorter in coparances to encodeURIComponent
function with the Primitive Strategies. Also, the query-pack
can encode complex types like object
or array
with the Complex Strategies where the encodeURIComponent
does not support compolex types.
Primitive Strategies
Upper Case
In URL encoding there are not replacing chars: numbers, upper and lower case English letters, -
, _
, .
, ~
. All other has encodes with extra chars, for instance @
encodes as %40
. zqip
replace upper case chars on the text with U
+ upper case char
or U{X}
+ X upper case chars
.
| Text | Encoded |
| ----- | -------- |
| Hello | U
hello |
| HTML | U5
html |
This helps to release all other upper case English letters for further encoding strategies.
String
Most used chars are replaced with upper case chars.
| Char | URL Encoding | query-pack |
| ------- | ------------ | ---- |
| space
| %20 | W |
| ' | %27 | H |
| ( | %28 | G |
| ) | %29 | R |
| ; | %3B | T |
| : | %3A | K |
| @ | %40 | M |
| = | %3D | J |
| + | %2B | P |
| , | %2C | C |
| ? | %3F | Q |
| " | %22 | H |
| | String | URL Encoding | query-pack | | ------ | ----------------- | --------------------------- | ------------------ | | Text | Hey, how are you? | Hey%2C%20how%20are%20you%3F | UheyCWhowWareWyouQ | | Length | 17 | 27 | 18 |
Number
Decimal numbers replaces with based32 numbers.
| | Number | query-pack | | ------ | ---------- | ------- | | Value | 123456.789 | 3oi0.ol | | Length | 10 | 7 |
Boolean
Replaces with 0
and 1
.
| Boolean | query-pack |
| ------- | ---- |
| false
| 0 |
| true
| 1 |
Complex Strategies
Complex strategy provides the way of converting into a string the object with properties or array of items. To list values need to split them somehow and indicate their type. The below table contains type indicators:
| Type | query-pack
type indicator |
| ----------- | --------------------- |
| string
| S |
| number
| N |
| boolean
| B |
| object
| O |
| array
| A |
| null
| L |
| undefined
| F |
Next table contains splitters:
| query-pack
splitter | Description |
| --------------- | ----------- |
| Y
| Property |
| X
| Object |
Array
| Type | Array | zqip
|
| ----------------------- | ----------------------- | -------------- |
| Number | [12, 34, 56] | NcN12N1o |
| String | ["cat", "dog", "mouse"] | ScatSdogSmouse |
| Number, String, Boolean | [12, "dog", true] | NcSdogB1 |
Object
Let's imaging we have the team object:
{
id: 1,
name: "Team 1",
captain: "zak",
}
After encoding into a string:
idN1YnameSUteamW1YcaptainSzak