Open Bug 1499988 Opened 1 year ago Updated 1 year ago

Fix Protocol.js documentation


(DevTools :: General, enhancement, P2)



(Not tracked)


(Reporter: yulia, Unassigned)


(Blocks 1 open bug)


Our protocol.js documentation is out of date. It recommends the following:

    const HelloFront = protocol.FrontClassWithSpec(helloWorldSpec, {
      initialize: function (client, form) {, client, form);
        // This call may not be required but it's a good idea. It will
        // guarantee that your instance is managed in the pool.

This results in the entire form object being passed into the front method, and if it is the form that we get with the target getFront method, then the `actor` field will always be `frameTarget`.

We need to update this documentation to either not pass in the form at all and set the actor ID manually (since the form parameter should go away soon:

or, we should change the documentation to follow this pattern:
Severity: normal → enhancement
Priority: -- → P2
You need to log in before you can comment on or make changes to this bug.