Add `.stringifyUrl()` method #217

komkanit · 2019-10-10T15:40:07Z

resolve #205
I create a method named stringifyUrl that does the inverse of .parseUrl()

sindresorhus · 2019-10-14T14:31:55Z

index.d.ts

+
+
+/**
+Stringify an object of URL and the query into a URL.


Would be useful with an example here.

sindresorhus · 2019-10-14T14:33:38Z

index.js

+	const queryFromUrl = this.extract(input.url);
+	const hash = getHash(input.url);
+	const stringifyQuery = this.stringify(input.query, options);
+	let queryString = [queryFromUrl, stringifyQuery].filter(str => str).join('&');


Don't use acronyms. str => string

readme.md

sindresorhus · 2019-10-14T14:34:19Z

readme.md

@@ -221,6 +221,21 @@ queryString.parseUrl('https://foo.bar?foo=bar');
 //=> {url: 'https://foo.bar', query: {foo: 'bar'}}
 ```

+### .stringifyUrl(object, options?)
+
+The inverse of [`.parseUrl()`](https://github.com/sindresorhus/query-string#parseurlstring-options)


Before this, it should describe what it does.

sindresorhus · 2019-10-14T14:34:53Z

readme.md

+
+The inverse of [`.parseUrl()`](https://github.com/sindresorhus/query-string#parseurlstring-options)
+
+The `object` are the same as result of `.parseUrl`


It's easier to just describe what it accepts specifically here.

sindresorhus · 2019-10-14T14:35:14Z

readme.md

+
+The `options` are the same as for `.stringify()`.
+
+Returns a URL with query string.


Suggested change

Returns a URL with query string.

Returns a URL with a query string.

sindresorhus · 2019-10-14T14:36:31Z

test/stringify-url.js

+	t.deepEqual(queryString.stringifyUrl({url: 'https://foo.bar?', query: {foo: 'bar'}}), 'https://foo.bar?foo=bar');
+	t.deepEqual(queryString.stringifyUrl({url: 'https://foo.bar/#top', query: {foo: 'bar'}}), 'https://foo.bar/?foo=bar#top');
+	t.deepEqual(queryString.stringifyUrl({url: 'https://foo.bar', query: {foo: 'bar', a: 'b'}}), 'https://foo.bar?a=b&foo=bar');
+	t.deepEqual(queryString.stringifyUrl({url: 'https://foo.bar?', query: {foo: ['bar', 'baz']}}), 'https://foo.bar?foo=bar&foo=baz');


Needs a test to show what happens if the URL already has a query string and a query string is specified.

Also add some tests that does parseUrl and then pass the result to stringifyUrl to make sure they are compatible.

sindresorhus · 2019-10-14T14:36:40Z

test/stringify-url.js

+import test from 'ava';
+import queryString from '..';
+
+test('stringify url not containing query string', t => {


Suggested change

test('stringify url not containing query string', t => {

test('stringify URL without query string', t => {

sindresorhus · 2019-10-14T14:36:48Z

test/stringify-url.js

+	t.deepEqual(queryString.stringifyUrl({url: 'https://foo.bar?foo=bar', query: {}}), 'https://foo.bar?foo=bar');
+});
+
+test('stringify url with query string', t => {


Suggested change

test('stringify url with query string', t => {

test('stringify URL with query string', t => {

sindresorhus · 2019-10-14T14:37:21Z

index.d.ts

@@ -206,3 +206,13 @@ export function stringify(
 Extract a query string from a URL that can be passed into `.parse()`.
 */
 export function extract(url: string): string;
+
+
+


No many empty lines

komkanit · 2019-10-15T15:41:40Z

@sindresorhus updated

sindresorhus · 2019-10-22T07:14:27Z

test/stringify-url.js

+	t.deepEqual(queryString.stringifyUrl({url: 'https://foo.bar/#top', query: {foo: 'bar'}}), 'https://foo.bar/?foo=bar#top');
+	t.deepEqual(queryString.stringifyUrl({url: 'https://foo.bar', query: {foo: 'bar', a: 'b'}}), 'https://foo.bar?a=b&foo=bar');
+	t.deepEqual(queryString.stringifyUrl({url: 'https://foo.bar?', query: {foo: ['bar', 'baz']}}), 'https://foo.bar?foo=bar&foo=baz');
+	t.deepEqual(queryString.stringifyUrl({url: 'https://foo.bar?foo=baz', query: {foo: 'bar'}}), 'https://foo.bar?foo=baz&foo=bar');


This would be surprising behavior for me. Adding another query item here with the same name actually changes the semantics as now the result would be an array instead of a string.

@sindresorhus you think the result would be https://foo.bar?foo[]=bas&foo[]=bar? I'm not sure what the answer would be.

No, that would be completely wrong as it's a different arrayFormat format.

I'm saying that it should replace instead: 'https://foo.bar?foo=bar'. The behavior should be clearly documented.

sindresorhus · 2019-10-22T07:14:28Z

#217 (comment) is not done. And the English-prose needs more work (typos + could be better written).

sindresorhus · 2019-11-13T04:20:03Z

Bump

komkanit · 2019-11-24T13:25:45Z

@sindresorhus I’m terribly sorry for absent communication. I'm practicing to write English correctly if you have any suggestion about the typo you can guide

sindresorhus · 2019-12-01T11:12:01Z

index.d.ts

+
+/**
+Stringify an object into a URL with a query string and sorting the keys.
+


You need to document the merging behavior here.

sindresorhus · 2019-12-01T11:12:42Z

index.d.ts

+```
+*/
+export function stringifyUrl(
+	input: ParsedUrl,


Suggested change

input: ParsedUrl,

object: ParsedUrl,

sindresorhus · 2020-01-16T14:47:09Z

Thanks for working on this :)

komkanit added 4 commits October 10, 2019 22:17

add stringifyUrl method

8939d39

add more test

21a8477

add type

b96de12

add document of stringifyUrl method

e287069

sindresorhus requested changes Oct 14, 2019

View reviewed changes

sindresorhus changed the title ~~Stringify URL method~~ Add .stringifyUrl() method Oct 14, 2019

komkanit added 5 commits October 15, 2019 21:55

add stringifyUrl example

c217c58

remove acronyms word

3ebf1e6

update stringifyUrl document

54e4780

add test about the URL already has a query string

e76bd7b

add test stringify URL from result of parseUrl

ad0f653

sindresorhus reviewed Oct 22, 2019

View reviewed changes

copy stringifyUrl description from readme

a0de598

Update stringify-url.js

b7907b0

sindresorhus reviewed Dec 1, 2019

View reviewed changes

komkanit and others added 8 commits December 8, 2019 11:59

change param name

e661440

fix test case query should be replace instead

1a187e1

update test result of parseUrl

c424ee5

sync document with readme

83449af

add document about the merging behavior

0a93fdb

Update index.d.ts

00f4233

Update readme.md

564d97c

Update index.js

75b42ca

sindresorhus merged commit 1604958 into sindresorhus:master Jan 16, 2020

snyk-bot mentioned this pull request Feb 7, 2020

[Snyk] Upgrade query-string from 6.9.0 to 6.10.0 qsays/lollipop#5

Open

snyk-bot mentioned this pull request Mar 6, 2020

[Snyk] Upgrade query-string from 6.1.0 to 6.11.0 AndreiShybin/bitshares-ui#6

Open

snyk-bot mentioned this pull request Apr 11, 2020

[Snyk] Upgrade query-string from 6.2.0 to 6.12.0 magneticflux-/angular4-hal#2

Open

snyk-bot mentioned this pull request Apr 23, 2020

[Snyk] Upgrade query-string from 6.0.0 to 6.11.1 christian7877/slack#4

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `.stringifyUrl()` method #217

Add `.stringifyUrl()` method #217

komkanit commented Oct 10, 2019

sindresorhus Oct 14, 2019

sindresorhus Oct 14, 2019

sindresorhus Oct 14, 2019

sindresorhus Oct 14, 2019

sindresorhus Oct 14, 2019

sindresorhus Oct 14, 2019

sindresorhus Dec 1, 2019

sindresorhus Oct 14, 2019

sindresorhus Oct 14, 2019

sindresorhus Oct 14, 2019

komkanit commented Oct 15, 2019

sindresorhus Oct 22, 2019

komkanit Nov 24, 2019

sindresorhus Dec 1, 2019

sindresorhus commented Oct 22, 2019

sindresorhus commented Nov 13, 2019

komkanit commented Nov 24, 2019

sindresorhus Dec 1, 2019

sindresorhus Dec 1, 2019

sindresorhus commented Jan 16, 2020


		The inverse of [`.parseUrl()`](https://github.com/sindresorhus/query-string#parseurlstring-options)

		The `object` are the same as result of `.parseUrl`


		The `options` are the same as for `.stringify()`.

		Returns a URL with query string.

	Returns a URL with query string.
	Returns a URL with a query string.

	test('stringify url not containing query string', t => {
	test('stringify URL without query string', t => {

	test('stringify url with query string', t => {
	test('stringify URL with query string', t => {


		/**
		Stringify an object into a URL with a query string and sorting the keys.

Add .stringifyUrl() method #217

Add .stringifyUrl() method #217

Conversation

komkanit commented Oct 10, 2019

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

Choose a reason for hiding this comment

komkanit commented Oct 15, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sindresorhus commented Oct 22, 2019

sindresorhus commented Nov 13, 2019

komkanit commented Nov 24, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sindresorhus commented Jan 16, 2020

Add `.stringifyUrl()` method #217

Add `.stringifyUrl()` method #217