Custom stringify arrays and objects #365

leninlin · 2020-05-02T12:49:53Z

I added the ability to compile the query string using a custom function for arrays and objects.

I need this to work with the Python REST framework (https://github.com/AltSchool/dynamic-rest):

qs.stringify({
  include: [ 'name', 'age' ],
  filter: {
    'age.gte': 18
  }
});
// include[]=name&include[]=age&filter{age.gte}=18

I added a function with curly brackets to the default list, but custom functions for the future will be useful for such situations.

…dArray

…ockfile

A new fourth argument is now provided when invoking the decoder inside parse, this argument represents whether the first argument (str) is a key or a value. This can then be used to decode key and values different within the decode function. A test has been added for this new behavior.

…rrays Fixes ljharb#327.

See ljharb/es-abstract#74

…, `has-symbols`, `tape`

Fixes ljharb#357

… treated as normal text Co-authored-by: Mohamed Omar <mohamed.ahmed.c209@gmail.com> Co-authored-by: Quentin de Longraye <quentin@dldl.fr>

Fixes ljharb#311. Followup to ljharb#336.

… arrays and objects with custom function

ljharb

Any changes to stringify would need to be mirrored in parse, so things can round trip.

I'm not yet convinced that this complexity is worth adding, but I appreciate you've made it appropriately generic.

dist/qs.js

leninlin · 2020-05-02T22:20:02Z

Any changes to stringify would need to be mirrored in parse, so things can round trip.

I'll think about it now

I'm not yet convinced that this complexity is worth adding, but I appreciate you've made it appropriately generic.

No problems. I can use fork for myself.

leninlin · 2020-05-03T00:05:12Z

Maybe something like that?

ljharb

I'm confused why there's both an array replacer and an object replacer, since for parse, they both do the same thing.

ljharb · 2020-06-19T23:06:03Z

README.md

+You may set `objectFormat: 'curly'` to enable curly brackets notation:
+
+```javascript
+var withDots = qs.parse('a{b}=c', { objectFormat: 'curly' });
+assert.deepEqual(withDots, { a: { b: 'c' } });


this is an extremely confusing and strange notation i've never seen anywhere else; i'm fine adding a function form so someone can do this themselves, but i'd need a lot of convincing that this format deserves first-class support.

ljharb · 2020-06-19T23:06:37Z

README.md

+qs.stringify({ a: { b: { c: 'd', e: 'f' } } }, { arrayFormat: 'curly' });
+// 'a{b}{c}=d&a{b}{e}=f'


similarly here

Suggested change

qs.stringify({ a: { b: { c: 'd', e: 'f' } } }, { arrayFormat: 'curly' });

// 'a{b}{c}=d&a{b}{e}=f'

ljharb · 2020-06-20T06:43:15Z

lib/parse.js

+    var key = givenKey;
+    if (typeof options.arrayFormat === 'function') {
+        key = options.arrayFormat(key);
+    } else if (options.arrayFormat in arrayKeyReplacer) {


Suggested change

} else if (options.arrayFormat in arrayKeyReplacer) {

} else if (has.call(arrayKeyReplacer, options.arrayFormat)) {

ljharb · 2020-06-20T06:43:31Z

lib/parse.js

+    }
+    if (typeof options.objectFormat === 'function') {
+        key = options.objectFormat(key);
+    } else if (options.objectFormat in objectKeyReplacer) {


Suggested change

} else if (options.objectFormat in objectKeyReplacer) {

} else if (has.call(objectKeyReplacer, options.objectFormat)) {

ljharb · 2020-06-20T06:45:39Z

lib/parse.js

+    curly: function curly(key) {
+        return key.replace(/\{([^{}[]+)\}/g, '[$1]');
+    },


Suggested change

curly: function curly(key) {

return key.replace(/\{([^{}[]+)\}/g, '[$1]');

},

ljharb · 2020-06-20T06:53:20Z

lib/stringify.js

+    var generateObjectPrefix;
+    if (opts && typeof opts.objectFormat === 'function') {
+        generateObjectPrefix = opts.objectFormat;
+    } else if (opts && opts.objectFormat in objectPrefixGenerators) {


Suggested change

} else if (opts && opts.objectFormat in objectPrefixGenerators) {

} else if (opts && has.call(objectPrefixGenerators, opts.objectFormat)) {

ljharb · 2020-06-20T06:53:39Z

lib/stringify.js

+    } else if (opts && opts.allowDots) {
+        generateObjectPrefix = objectPrefixGenerators.dots;
+    } else {
+        generateObjectPrefix = objectPrefixGenerators.brackets;
+    }


this seems like it should be handled by the option normalization and the default?

ljharb · 2020-06-20T06:53:54Z

test/parse.js

        st.deepEqual(qs.parse('a[]=b&a[]=c', { arrayFormat: 'comma' }), { a: ['b', 'c'] });
        st.deepEqual(qs.parse('a[0]=b&a[1]=c', { arrayFormat: 'comma' }), { a: ['b', 'c'] });
-        st.deepEqual(qs.parse('a=b,c', { arrayFormat: 'comma' }), { a: 'b,c' });
+        st.deepEqual(qs.parse('a=b,c', { arrayFormat: 'comma' }), { a: ['b', 'c'] });


this shouldn't change, or else it's a breaking change

ljharb · 2021-01-13T16:06:42Z

@leninlin are you still interested in completing this PR?

ljharb and others added 30 commits August 16, 2019 19:43

[Tests] Buffer.from in node v5.0-v5.9 and v4.0-v4.4 requires a Type…

e39c235

…dArray

[Dev Deps] update eslint, @ljharb/eslint-config, evalmd

760a670

[Tests] up to node v12.10, v11.15, v10.16, v8.16

97154a6

[Tests] add posttest using npx aud to run npm audit without a l…

4019179

…ockfile

[Dev Deps] update eslint

df0cb44

[Tests] parse: add passing arrayFormat tests

dadf9db

v6.9.0

670254b

[fix] parse: with comma true, do not split non-string values

698b683

[Fix] parse: with comma true, handle field that holds an array of a…

f884e2d

…rrays Fixes ljharb#327.

[Dev Deps] update eslint, @ljharb/eslint-config

1f35831

[meta] add funding field

b9a032f

[Tests] use shared travis-ci config

6151be3

v6.9.1

7b36800

[meta] add tidelift marketing copy

152b26c

[Fix] parse: throw a TypeError instead of an Error for bad charset

fe6384c

[actions] add automatic rebasing / merge commit blocking

76e4570

See ljharb/es-abstract#74

[meta] fix indentation in package.json

72dc89f

[meta] ignore eclint transitive audit warning

5af2bf8

[Dev Deps] update eslint, @ljharb/eslint-config, object-inspect…

eac5616

…, `has-symbols`, `tape`

[Dev Deps] update @ljharb/eslint-config, tape

0625c49

[Fix] parse: Fix parsing array from object with comma true

eecd28d

Fixes ljharb#357

[Dev Deps] update tape, mkdirp, iconv-lite

911efab

v6.9.2

ddc1ff9

Merge changelogs from v6.7.1, v6.8.1

37f6a6b

[Fix] parses comma delimited array while having percent-encoded comma…

cd9a3cd

… treated as normal text Co-authored-by: Mohamed Omar <mohamed.ahmed.c209@gmail.com> Co-authored-by: Quentin de Longraye <quentin@dldl.fr>

[Fix] proper comma parsing of URL-encoded commas

bf0ea91

Fixes ljharb#311. Followup to ljharb#336.

Merge changelogs from v6.7.2, v6.8.2

8d1dea2

v6.9.3

511e1c9

Add stringify objects with curly braces and add possibility stringify…

0932740

… arrays and objects with custom function

ljharb added feature request stringify labels May 2, 2020

ljharb requested changes May 2, 2020

View reviewed changes

dist/qs.js Outdated Show resolved Hide resolved

Revert dist files

e25d9aa

Add mirror to parse.js

ac71264

Fix example in README

422d2c2

leninlin requested a review from ljharb May 31, 2020 14:55

ljharb requested changes Jun 20, 2020

View reviewed changes

ljharb added the parse label Jun 20, 2020

ljharb marked this pull request as draft January 13, 2021 16:06

ljharb force-pushed the master branch from e3b562a to facbd0e Compare February 17, 2021 00:51

ljharb force-pushed the master branch from 44b6031 to 24c19cc Compare November 9, 2021 19:52

ljharb force-pushed the main branch from a5371f6 to c8a269f Compare February 29, 2024 23:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Custom stringify arrays and objects #365

Custom stringify arrays and objects #365

leninlin commented May 2, 2020 •

edited

ljharb left a comment

leninlin commented May 2, 2020

leninlin commented May 3, 2020

ljharb left a comment

ljharb Jun 19, 2020

ljharb Jun 19, 2020

ljharb Jun 20, 2020

ljharb Jun 20, 2020

ljharb Jun 20, 2020

ljharb Jun 20, 2020

ljharb Jun 20, 2020

ljharb Jun 20, 2020

ljharb commented Jan 13, 2021

		qs.stringify({ a: { b: { c: 'd', e: 'f' } } }, { arrayFormat: 'curly' });
		// 'a{b}{c}=d&a{b}{e}=f'

	} else if (options.arrayFormat in arrayKeyReplacer) {
	} else if (has.call(arrayKeyReplacer, options.arrayFormat)) {

	} else if (options.objectFormat in objectKeyReplacer) {
	} else if (has.call(objectKeyReplacer, options.objectFormat)) {

	curly: function curly(key) {
	return key.replace(/\{([^{}[]+)\}/g, '[$1]');
	},

	} else if (opts && opts.objectFormat in objectPrefixGenerators) {
	} else if (opts && has.call(objectPrefixGenerators, opts.objectFormat)) {

Custom stringify arrays and objects #365

Are you sure you want to change the base?

Custom stringify arrays and objects #365

Conversation

leninlin commented May 2, 2020 • edited

ljharb left a comment

Choose a reason for hiding this comment

leninlin commented May 2, 2020

leninlin commented May 3, 2020

ljharb left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ljharb commented Jan 13, 2021

leninlin commented May 2, 2020 •

edited