Use proxy.onRequest in proxy API documentation

RESOLVED FIXED

Status

task
RESOLVED FIXED
2 months ago
Last month

People

(Reporter: robwu, Unassigned)

Tracking

(Blocks 1 bug)

66 Branch
Dependency tree / graph

Firefox Tracking Flags

(Not tracked)

Details

Reporter

Description

2 months ago

The following examples refer to PAC / proxy.register. They should be updated to exclusively mention the proxy.onRequest method:

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

2 months 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.

Flags: needinfo?(mconca)
Reporter

Updated

2 months ago
Type: defect → task

(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

Flags: needinfo?(mconca)
Status: NEW → RESOLVED
Closed: Last month
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.