ljharb/qs

Square brackets as object key

Open

#343 opened on Nov 5, 2019

View on GitHub
 (12 comments) (0 reactions) (0 assignees)JavaScript (744 forks)batch import
bughelp wantedquestionstringify

Repository metrics

Stars
 (8,015 stars)
PR merge metrics
 (Avg merge 6d 22h) (2 merged PRs in 30d)

Description

I have following object:

{
  "filter": {
    "/person[]/email": "test@test"
  }
}

When I use it in query string - at the end the result is not the same object:

qs.stringify(...) // => filter%5B%2Fperson%5B%5D%2Femail%5D=test%40test
qs.parse(...) // => { "filter[/person" : ["test@test"] }

'[]' in object key name is the problem - so I replaced them with another character. But I wanna know - can I somehow escape special characters in cases like this one?

Contributor guide

Research direction
Examine the qs library's parsing logic to understand how square brackets in keys are interpreted. Look at the encode/decode functions and the handling of brackets as delimiters vs literal characters. Consider edge cases and potential escapes.
Tech stack
javascript
Domain
backendapi
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75