ljharb/qs

Stringify with `comma` format should add square brackets to parameter name to identity array with single value

Open

#315 创建于 2019年6月4日

在 GitHub 查看
 (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
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
active
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
JavaScript basicsqs library usagearray format concept
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
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.