Use proxy.onRequest in proxy API documentation
Categories
(WebExtensions :: General, task)
Tracking
(Not tracked)
People
(Reporter: robwu, Unassigned)
References
Details
The following examples refer to PAC / proxy.register. They should be updated to exclusively mention the proxy.onRequest method:
- https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/proxy
- https://github.com/mdn/webextensions-examples/tree/master/proxy-blocker
The proxy.onError page also demonstrates the event by a PAC script. The description at the top and the example should be updated, to explain that the error can be triggered by throwing or returning an invalid value in the proxy.onRequest event handler:
|
Reporter | |
Comment 1•5 years ago
|
||
Mike, I created this new issue because this change requires more effort than simply slapping a "Deprecated" notice at the top of the page ( https://bugzilla.mozilla.org/show_bug.cgi?id=1545811#c2 ).
If it is in the scope of https://github.com/mdn/sprints/issues/1364 , please update your documentation change request.
|
|
Reporter | |
Updated•5 years ago
|
|
||
Comment 2•5 years ago
|
||
(In reply to Rob Wu [:robwu] from comment #1)
Mike, I created this new issue because this change requires more effort than simply slapping a "Deprecated" notice at the top of the page ( https://bugzilla.mozilla.org/show_bug.cgi?id=1545811#c2 ).
If it is in the scope of https://github.com/mdn/sprints/issues/1364 , please update your documentation change request.
I updated the documentation issue to capture the additional concerns around the content on the proxy API:
https://github.com/mdn/sprints/issues/1364
I created a new issue in the WebExtensions Examples repo to track updating the proxy example:
https://github.com/mdn/webextensions-examples/issues/410
|
||
Updated•5 years ago
|
Description
•