ljharb/qs

Option to avoid percent-encoding sub-delims such as commas

Open

#237 aperta il 4 dic 2017

Vedi su GitHub
 (3 commenti) (14 reazioni) (0 assegnatari)JavaScript (744 fork)batch import
enhancementhelp wantedstringify

Metriche repository

Star
 (8015 star)
Metriche merge PR
 (Merge medio 6g 22h) (2 PR mergiate in 30 g)

Descrizione

According to RFC 3986, the query string of a URI may contain sub-delims (including commas). Can we have an option to avoid percent-encoding them? Or possibly don't encode them by default?

Rationale

Leaving allowed sub-delims unencoded results in far more readable query strings with better overall usability. E.g., alpha,beta,gamma is better than alpha%2Cbeta%2Cgamma.

The RFC actually hints at the importance of this in section 3.4. In reference to percent-encoding / and ?, two examples of reserved delimiters that are allowed in query strings, it states:

...it is sometimes better for usability to avoid percent-encoding those characters.

I'm sure there are others, but one prominent use case is the include parameter in JSON API, as well as its filter recommendations.

Possible syntax

We could offer fine-grained control over which sub-delims are not percent-encoded.

jq.stringify(obj, {allowChars: [',']});

Guida contributor