Hint that using `data` is wrong #1000

jimmywarting · 2020-10-28T11:46:53Z

From time to time i see ppl using data instead of body which is wrong.
happened just recently in #481 (comment)

how do you feel about adding a little warning message that can only appear once. (kinda like node reports that you are using experimental apis)

if ('data' in bodyInit && notWarned) {
  console.warn('use body instead')
}
class Response {
  get data () {
    notWarned && console.warn('you want to use .json(), .text(), .arrayBuffer() or just .body')
  }
}

I don't think it is uncommon to see those mistake happening when switching from different request libraries axios use data instead of body for example. I can admit that i have used data as well and wasted minutes trying to figure out what's wrong

The text was updated successfully, but these errors were encountered:

jimmywarting · 2020-10-28T11:49:43Z

Yay, i claimed issue 1000 🎉

dork1 · 2020-10-28T12:01:38Z

I am still learning all the ins and outs of various libraries and indeed my code was adapted from an axios example so an error like stated above would help loads in pinpointing the problem. Thank you! @jimmywarting

tekwiz · 2020-12-20T18:06:23Z

@jimmywarting I think this makes sense, but I would throw an Error because they're probably going to get one anyway when they try to use the undefined return value

jimmywarting · 2020-12-21T17:38:16Z

I don't think an error should be thrown... it's not what is happening in (mostly) any method where you are allowed to pass in a object, other options are just ignored. it has the risk to break things as it wouldn't be backwards compatible.

You can get a request option from an arbitrary place that could include both body and data option and dosen't fully looks like a Request init option.

We try to align us self with how the whatwg fetch works in the browser and the spec. we never know the true intention if the developer really meant to post the data option or if it's just a extra arbitrary option that comes from somewhere else

edit ups, i was talking about the Request constructor... totally forgot that it was about the Response.data

But yea, a warning on the request constructor would also be helpful :P

when i think about it response.data could potentially throw a TypeError but new Request(x, { method: 'post', data }) should warn

tekwiz · 2020-12-21T23:59:26Z

@jimmywarting And oops for me, too... I was only thinking about Response.data. I agree with this, and I also agree now with what you were saying about warning only once:

when i think about it response.data could potentially throw a TypeError but new Request(x, { method: 'post', data }) should warn

Richienb · 2020-12-27T12:27:50Z

It's a good idea, but I'm not sure how far we should deviate from the original fetch spec.

jimmywarting · 2020-12-27T19:50:44Z

It's a good idea, but I'm not sure how far we should deviate from the original fetch spec.

it's not like we are adding any new feature/method into fetch, it's just a way of helping/notifying that what you might be doing is wrong. such notification could easily be removed if we ever decide to ditch it again

xxczaki added enhancement good first issue labels Dec 25, 2020

Jun	JUL	Oct
	25
2020	2021	2024

node-fetch / node-fetch

Hint that using `data` is wrong #1000

Hint that using `data` is wrong #1000

jimmywarting commented Oct 28, 2020 •

edited

jimmywarting commented Oct 28, 2020

dork1 commented Oct 28, 2020

tekwiz commented Dec 20, 2020

jimmywarting commented Dec 21, 2020 •

edited

tekwiz commented Dec 21, 2020

Richienb commented Dec 27, 2020

jimmywarting commented Dec 27, 2020 •

edited

node-fetch / node-fetch

Sponsor node-fetch/node-fetch

Hint that using data is wrong #1000

Hint that using data is wrong #1000

Comments

jimmywarting commented Oct 28, 2020 • edited

jimmywarting commented Oct 28, 2020

dork1 commented Oct 28, 2020

tekwiz commented Dec 20, 2020

jimmywarting commented Dec 21, 2020 • edited

tekwiz commented Dec 21, 2020

Richienb commented Dec 27, 2020

jimmywarting commented Dec 27, 2020 • edited

Hint that using `data` is wrong #1000

Hint that using `data` is wrong #1000

jimmywarting commented Oct 28, 2020 •

edited

jimmywarting commented Dec 21, 2020 •

edited

jimmywarting commented Dec 27, 2020 •

edited