Add `searchParams` option #57

itaisteinherz · 2018-10-26T21:24:31Z

Fixes #54

szmarczak · 2018-10-26T21:32:40Z

index.js

@@ -86,13 +86,14 @@ const timeout = (promise, ms) => Promise.race([
 ]);

 class Ky {
-	constructor(input, {timeout = 10000, hooks = {beforeRequest: []}, throwHttpErrors = true, json, ...otherOptions}) {
+	constructor(input, {timeout = 10000, hooks = {beforeRequest: []}, throwHttpErrors = true, searchParams = '', json, ...otherOptions}) {


searchParams, (no empty string)

index.js

szmarczak · 2018-10-26T21:37:44Z

index.js

 		this._retryCount = 0;

 		this._options = {
 			method: 'get',
 			credentials: 'same-origin', // TODO: This can be removed when the spec change is implemented in all browsers. Context: https://www.chromestatus.com/feature/4539473312350208
 			retry: 2,
+			searchParams: new URLSearchParams(searchParams),


This line is useless

itaisteinherz · 2018-10-26T21:58:11Z

Thanks for the detailed review @szmarczak 👍🏻
I'm still not sure why the build fails, since URLSearchParams should be available on Node.js v8.

szmarczak · 2018-10-26T22:24:43Z

And it is, but it isn't a global. We would need to access it through require('url'). But we don't need that cuz we don't target Node. We target browsers only.

See #51. We can't do anything about that yet.

szmarczak · 2018-10-26T22:26:39Z

index.js

-		this._input = this._options.prefixUrl + this._input;
+		const url = new URL(this._options.prefixUrl + this._input);
+		if (searchParams) {
+			url.search = searchParams instanceof URLSearchParams ? searchParams : new URLSearchParams(searchParams).toString();


What about:

if (typeof searchParams === 'string') { url.search = searchParams; } else { url.search = new URLSearchParams(searchParams).toString(); }

Your suggestion looks good to me, except for the fact that if searchParams is an instance of URLSearchParams you end up initiating a clone of it for no reason.
We could do this:

if (typeof searchParams === 'string' || searchParams instanceof URLSearchParams) { url.search = searchParams; } else { url.search = new URLSearchParams(searchParams).toString(); }

Which both doesn't parse strings nor URLSearchParams objects.

Lemme fix your code:

if (typeof searchParams === 'string') { url.search = searchParams; } else if (searchParams instanceof URLSearchParams) { url.search = searchParams.toString(); } else { url.search = new URLSearchParams(searchParams).toString(); }

I hope it works as expected

We could do that, but from my testing in both Node and my browser (Chrome), url.search = searchParams works.

This is how I tested it:

I haven't checked that so I didn't know, thanks for the explanation :) If you made a commit with that it would be great :)

In a flash ;)

I ended up doing:

if (typeof searchParams === 'string' || searchParams instanceof URLSearchParams) { url.search = searchParams; } else if (searchParams) { url.search = new URLSearchParams(searchParams).toString(); }

Since if the searchParams option isn't defined, the test prefix-url › prefixUrl option fails (which makes sense).

itaisteinherz · 2018-10-27T08:51:18Z

@szmarczak Can you mark #57 (comment) as resolved? We've already addressed the issue in the discussion on #57 (comment) and in 6bb65d0.

maple3142 · 2018-10-27T09:10:36Z

How about handling this one?

ky('https://example.com/?a=1&b=2', { searchParams: { a: 2 } })

itaisteinherz · 2018-10-27T09:45:49Z

@maple3142 Currently, all query parameters get ignored when the searchParams option is supplied, and so in your example the final URL which will be requested is https://example.com/?a=2.
This behavior was derived from #54 (comment).

sindresorhus · 2018-10-27T19:21:08Z

This looks good, but I need some feedback on what behavior to use when a plain Object is given. See sindresorhus/got#638. There can be confusion if someone specifies, for example, searchParams: {foo: [1, 2]}. My idea in sindresorhus/got#643, was to limit the values to just strings when a plain object is given. That would mean searchParams: {foo: 1} would have to be specified as searchParams: {foo: '1'} which is inconvenient. We could also allow numbers, but where do we set the limit? Only allow strings and numbers as values?

// @mrtnbroder @mrmlnc @vitkarpov @brandon93s

sindresorhus · 2018-10-27T19:29:26Z

And do anyone disagree that it should replace the search params already in the URL instead of merging them in?

itaisteinherz · 2018-10-28T07:22:30Z

@sindresorhus I've implemented your suggestion. Currently only strings and numbers are allowed, although we could probably support any primitive type excluding objects and arrays.

index.js

felixfbecker · 2018-10-31T18:36:48Z

It should probably mirror what new URLSearchParams(object) does.

sholladay · 2018-10-31T23:06:00Z

Don't forget to update the TypeScript types (see #49 as an example).

The build failure should be easy to fix now that the Cypress tests are up and running. :)

sindresorhus · 2018-11-01T04:30:14Z

Don't forget to update the TypeScript types (see #49 as an example).

And also add a test to https://github.com/sindresorhus/ky/blob/master/index.test-d.ts

sindresorhus · 2018-11-01T04:30:23Z

Can you also fix the merge conflict?

test/main.js

readme.md

itaisteinherz · 2018-11-01T08:35:40Z

The build failure should be easy to fix now that the Cypress tests are up and running. :)

@sholladay I've never used Cypress before, and so I'm not sure how to fix the build failure.
Also, the build fails on Node.js v8 because of URLSearchParams not being available when testing using AVA. Am I supposed to port all AVA tests to Cypress, or just the searchParams-related ones (or something else)?

index.js

test/main.js

sindresorhus · 2018-11-01T08:49:19Z

@itaisteinherz No, we'll only use Cypress when it's impossible to use Node.js testing. Accept my code suggestion above and then rebase from master branch and the test should pass ;)

Co-Authored-By: itaisteinherz <itaisteinherz@gmail.com>

itaisteinherz · 2018-11-01T09:34:16Z

Accept my code suggestion above and then rebase from master branch and the test should pass ;)

Done, but I still had to merge from master because I couldn't figure out how to rebase properly 😓
Thanks for pointing out what needed to be changed in order to make the CI build pass 👍🏻

szmarczak · 2018-11-01T11:37:31Z

LGTM.

sindresorhus · 2018-11-01T11:49:43Z

This still needs TypeScript typings, like mentioned in #57 (comment). Otherwise, the code changes are looking good.

itaisteinherz · 2018-11-01T12:49:45Z

@sindresorhus I'll finish the TypeScript typings in an hour or so.

itaisteinherz · 2018-11-01T13:15:13Z

Done in 8c8c1ca 👌🏻

sindresorhus · 2018-11-01T17:53:37Z

You missed #57 (comment), but I can fix that for you.

sindresorhus · 2018-11-01T17:53:49Z

Thank you for working on this :)

itaisteinherz added 2 commits October 27, 2018 00:21

Add searchParams option

3fdcf8e

Improve documentation

3449498

szmarczak requested changes Oct 26, 2018

View reviewed changes

Update index.js based on review

489bbe9

szmarczak requested changes Oct 26, 2018

View reviewed changes

Improve searchParams option parsing

6bb65d0

szmarczak approved these changes Oct 27, 2018

View reviewed changes

Validate object param

b600401

sindresorhus reviewed Oct 28, 2018

View reviewed changes

index.js Show resolved Hide resolved

itaisteinherz added 2 commits October 28, 2018 13:17

Throw if searchParams option is invalid

21f3534

Update documentation of searchParams option

785aa2b

sindresorhus reviewed Nov 1, 2018

View reviewed changes

test/main.js Outdated Show resolved Hide resolved

sindresorhus reviewed Nov 1, 2018

View reviewed changes

readme.md Outdated Show resolved Hide resolved

sindresorhus force-pushed the master branch from 383d754 to f107e7b Compare November 1, 2018 04:57

itaisteinherz and others added 4 commits November 1, 2018 07:46

Update based on feedback

9464d22

Update readme.md

7a239f4

Merge branch 'master' into add-option-searchParams

87573b1

Fix linting

d53e2cf

sindresorhus reviewed Nov 1, 2018

View reviewed changes

index.js Outdated Show resolved Hide resolved

sindresorhus reviewed Nov 1, 2018

View reviewed changes

index.js Outdated Show resolved Hide resolved

sindresorhus reviewed Nov 1, 2018

View reviewed changes

index.js Outdated Show resolved Hide resolved

sindresorhus reviewed Nov 1, 2018

View reviewed changes

test/main.js Outdated Show resolved Hide resolved

sindresorhus and others added 5 commits November 1, 2018 11:06

Use URLSearchParams from _globalThis

9899a29

Co-Authored-By: itaisteinherz <itaisteinherz@gmail.com>

Use URL from _globalThis

cddee89

Co-Authored-By: itaisteinherz <itaisteinherz@gmail.com>

Use URLSearchParams from _globalThis

1fe34da

Co-Authored-By: itaisteinherz <itaisteinherz@gmail.com>

Use URLSearchParams from global

326c83e

Co-Authored-By: itaisteinherz <itaisteinherz@gmail.com>

Merge branch 'master' into add-option-searchParams

e28fd25

Add TypeScript typings

8c8c1ca

Update index.d.ts

9a32b60

sindresorhus merged commit a7c71b5 into sindresorhus:master Nov 1, 2018

sindresorhus added a commit that referenced this pull request Nov 1, 2018

Fixup #57

41c706f

dangdennis pushed a commit to dangdennis/ky that referenced this pull request Nov 4, 2018

Add searchParams option (sindresorhus#57)

76143d1

dangdennis pushed a commit to dangdennis/ky that referenced this pull request Nov 4, 2018

Fixup sindresorhus#57

14a7d67

dangdennis pushed a commit to dangdennis/ky that referenced this pull request Nov 4, 2018

Add searchParams option (sindresorhus#57)

286d4ed

dangdennis pushed a commit to dangdennis/ky that referenced this pull request Nov 4, 2018

Fixup sindresorhus#57

f17bd7f

sholladay mentioned this pull request May 8, 2021

Support relative URLs whatwg/url#531

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `searchParams` option #57

Add `searchParams` option #57

itaisteinherz commented Oct 26, 2018 •

edited by szmarczak

Loading

szmarczak Oct 26, 2018

szmarczak Oct 26, 2018 •

edited

Loading

itaisteinherz commented Oct 26, 2018

szmarczak commented Oct 26, 2018

szmarczak Oct 26, 2018

itaisteinherz Oct 26, 2018

szmarczak Oct 27, 2018

itaisteinherz Oct 27, 2018

szmarczak Oct 27, 2018

itaisteinherz Oct 27, 2018

itaisteinherz Oct 27, 2018

itaisteinherz commented Oct 27, 2018

maple3142 commented Oct 27, 2018

itaisteinherz commented Oct 27, 2018

sindresorhus commented Oct 27, 2018

sindresorhus commented Oct 27, 2018

itaisteinherz commented Oct 28, 2018

felixfbecker commented Oct 31, 2018

sholladay commented Oct 31, 2018

sindresorhus commented Nov 1, 2018

sindresorhus commented Nov 1, 2018

itaisteinherz commented Nov 1, 2018

sindresorhus commented Nov 1, 2018

itaisteinherz commented Nov 1, 2018 •

edited

Loading

szmarczak commented Nov 1, 2018

sindresorhus commented Nov 1, 2018 •

edited

Loading

itaisteinherz commented Nov 1, 2018 •

edited

Loading

itaisteinherz commented Nov 1, 2018

sindresorhus commented Nov 1, 2018

sindresorhus commented Nov 1, 2018

Add searchParams option #57

Add searchParams option #57

Conversation

itaisteinherz commented Oct 26, 2018 • edited by szmarczak Loading

Choose a reason for hiding this comment

szmarczak Oct 26, 2018 • edited Loading

Choose a reason for hiding this comment

itaisteinherz commented Oct 26, 2018

szmarczak commented Oct 26, 2018

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

itaisteinherz commented Oct 27, 2018

maple3142 commented Oct 27, 2018

itaisteinherz commented Oct 27, 2018

sindresorhus commented Oct 27, 2018

sindresorhus commented Oct 27, 2018

itaisteinherz commented Oct 28, 2018

felixfbecker commented Oct 31, 2018

sholladay commented Oct 31, 2018

sindresorhus commented Nov 1, 2018

sindresorhus commented Nov 1, 2018

itaisteinherz commented Nov 1, 2018

sindresorhus commented Nov 1, 2018

itaisteinherz commented Nov 1, 2018 • edited Loading

szmarczak commented Nov 1, 2018

sindresorhus commented Nov 1, 2018 • edited Loading

itaisteinherz commented Nov 1, 2018 • edited Loading

itaisteinherz commented Nov 1, 2018

sindresorhus commented Nov 1, 2018

sindresorhus commented Nov 1, 2018

Add `searchParams` option #57

Add `searchParams` option #57

itaisteinherz commented Oct 26, 2018 •

edited by szmarczak

Loading

szmarczak Oct 26, 2018 •

edited

Loading

itaisteinherz commented Nov 1, 2018 •

edited

Loading

sindresorhus commented Nov 1, 2018 •

edited

Loading

itaisteinherz commented Nov 1, 2018 •

edited

Loading