ljharb/qs

stringify, request supporting 'dot' as option for arrayFormat

Open

#516 opened on Nov 1, 2024

View on GitHub
 (3 comments) (0 reactions) (0 assignees)JavaScript (8,015 stars) (744 forks)batch import
feature requesthelp wantedstringify

Description

parse can successfully convert 'a.0.name=test&a.0.number=5&a.1.name=test2&a.1.number=6' to:

{ a: [ { name: 'test', number: '5'}, { name: 'test2', number: '6' }] }

so it would be great if there were a stringify option that could convert the object back into the original dot notation.

Contributor guide

Tech stack
javascript
Domain
api
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
understanding of qs libraryJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the existing stringify function in the qs source code (likely in lib/stringify.js). Look at how arrayFormat options are handled for other formats (brackets, indices, repeat, comma). Implement a 'dot' option that converts an array back to dot notation like 'a.0.name=test'. Reference the parse implementation that already supports dot notation to ensure consistency.