Stringify with `comma` format should add square brackets to parameter name to identity array with single value · ljharb/qs#315

(17 留言) (5 反應) (0 負責人)JavaScript (8,015 star) (744 fork)batch import

enhancementhelp wantedstringify

描述

Hi. With new comma array format, stringify of array with single value will produce following result:

const options = {
    arrayFormat: 'comma'
};
qs.stringify({foo: [1]}, options); // foo=1
qs.stringify({foo: [1, 2]}, options); // foo=1,2

So, on parse stage, parsing will produce single value.

qs.parse('foo=1); // {foo: 1}
qs.parse('foo=1,2'); // {foo: [1, 2]}

Maybe add square brackets to parameter name, when comma array format is used?

qs.stringify({foo: [1]}, options); // foo[]=1
qs.stringify({foo: [1, 2]}, options); // foo[]=1,2

qs.parse('foo[]=1); // {foo: [1]}
qs.parse('foo[]=1,2'); // {foo: [1, 2]}

Currently, parsing of the following query string foo[]=1,2 working as expected

技術棧: javascript
領域: backendapi
議題類型: feature
難度: 3
預計時間: 1-3 hours
活動狀態: active
清晰度: clear
前置要求: JavaScript basicsqs library usagearray format concept
新手友善度: 70
研究方向: Review the stringify and parse functions in the qs library, specifically the handling of arrayFormat: 'comma'. The change would modify the stringify function to output brackets when the value is an array with a single element, and ensure parse handles the resulting 'foo[]=1' correctly. Check existing tests for comma format to understand expected behavior and ensure backward compatibility. The discussion in the issue (comments) may provide additional insights or concerns about the proposed change.