ljharb/qs

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

Offen

#237 geöffnet am 04.12.2017

 (3 Kommentare) (14 Reaktionen) (0 zugewiesene Personen)JavaScript (904 Forks)batch import
enhancementhelp wantedstringify

Repository-Metriken

Stars
 (8.943 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 6T 22h) (2 gemergte PRs in 30 T)

Beschreibung

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: [',']});

Contributor Guide