Fix docs for method in XHRUpload

[pedantic-git]

Following conversation with @Murderlon in #5165, this is a patch to the documentation that makes it clear methods need to be specified in capitals from version 3.6.5 onwards.

[github-actions]

Diff output files

No diff

[aduh95]

TBH we should probably fix the regression (at least on the 3.x branch) rather than document it. This kind of breaking change should only happen in semver major versions.

[pedantic-git]

@aduh95 I'm following the suggestion from @Murderlon here, who closed the above issue asking for it to be documented. FWIW I do agree with the semver point - it was surprising to find this component had been completely rewritten in TS between versions 3.6.1 and 3.6.2!

[aduh95]

I've opened #5179 to fix the regression. I'd be in favor to instead document that using lowercase method is deprecated, and then in 4.x only uppercase ones will be accepted.

it was surprising to find this component had been completely rewritten in TS between versions 3.6.1 and 3.6.2!

The TS refactor should not have any effect on the npm package, so IMO it's perfectly valid that it happened in a patch release.

[Murderlon]

Fixing the regression is indeed the better solution. I was about to do that myself but didn't get around to it yet. For context, the source is in TS but the types are not published to theoretically nothing changed.

[aduh95]

@pedantic-git would you be making this PR document the deprecation, or would you rather have me do it?

[pedantic-git]

I'd prefer it if you did, if that's OK. Thank you!