Adding a flag to disable automatic inclusion of x-requested-with

[rorticus]

Type: feature

The following has been addressed in the PR:

• There is a related issue
• All code matches the style guide
• Unit or Functional tests are included in the PR

Description:

Adding an XHR request option, includeRequestedWith that defaults to true, that can be used to disable the automatic inclusion of the X-Requested-With.

Example,

xhr('some-url', { includeRequestedWith: false }).then(...)

Resolves #328

[kitsonk]

My only concern with this is that in general we don't have good documentation for any of this, and now we are adding to it. Without any JSDoc, the API docs won't contain anything as well. At the very least, we should add JSDoc for options we add, we already have a cleanup task to go back over and review stuff, so lets just not add to the pile of debt.

[agubler]

That's a good point Kit, we should definitely be looking to at least have JSDoc (and even better README doc too)

[kitsonk]

Yeah, I was going to say README, but realise for core that is a ginormous task and actually for lots of it, just sane API docs is likely to be better, maybe... Adding this particular flag to the README would be a bit crazy as it stands at the moment, since this is our request documentation at the moment:

HTTP requests

The @dojo/core/request module contains methods to simplify making http requests. It can handle making requests in both node and the browser through the same methods.

[rorticus]

Added some jsdoc for request options 😄