ljharb/qs

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

Open

#315 opened on 2019年6月4日

GitHub で見る
 (17 comments) (5 reactions) (0 assignees)JavaScript (8,015 stars) (744 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.