exportFunction()

Syntax

let exportedFunction = exportFunction(
  func,              // function
  targetScope,       // object
  options            // optional object
);

Parameter

func

function. Die zu exportierende Funktion.

targetScope

object. Das Objekt, an das die Funktion angehängt werden soll. Dies muss nicht das globale window-Objekt sein; es könnte ein Objekt im Ziel-Fenster oder vom Aufrufer erstellt sein.

options Optional

object. Optionen für die Funktion.

defineAs Optional

string. Der Name der Funktion in targetScope. Falls weggelassen, müssen Sie den Rückgabewert von exportFunction() einem Objekt im Zielkontext zuweisen.

allowCrossOriginArguments Optional

boolean. Ob geprüft werden soll, dass Argumente der exportierten Funktion vom Aufrufer übernommen werden. Dies erlaubt es dem Aufrufer, Objekte mit einem anderen Ursprung in die exportierte Funktion einzubringen, die dann ihren privilegierten Status nutzen kann, um Cross-Origin-Anfragen mit dem Objekt zu machen. Standard ist false.

Rückgabewert

Die im Zielkontext erstellte Platzhalterfunktion.

Exportieren von Funktionen, die Argumente akzeptieren

Alle an die Funktion übergebenen Argumente werden nicht geklont. Stattdessen werden sie durch den privilegierten Kontext als Xrays geleitet.

Das Argument modifizieren

Ein Xray für ein Objekt bezieht sich auf das Original. Jegliche Änderungen am Argument, die in der exportierten Funktion vorgenommen werden, beeinflussen das übergebene Originalobjekt. Zum Beispiel:

// privileged scope: for example, a content script
function changeMyName(user) {
  user.name = "Bill";
}
exportFunction(changeMyName, window, {
  defineAs: "changeMyName",
});

// less-privileged scope: for example, a page script
const user = { name: "Jim" };
const test = document.getElementById("test");
test.addEventListener("click", () => {
  console.log(user.name); // "Jim"
  window.changeMyName(user);
  console.log(user.name); // "Bill"
});

Dieses Verhalten unterliegt den normalen Regeln von Xrays. Zum Beispiel ist eine zu einem DOM-Knoten hinzugefügte Expando-Eigenschaft im Originalobjekt nicht sichtbar.

Xray-Filterung und Verzicht

Xrays bieten eine gefilterte Ansicht des Originalobjekts. Zum Beispiel sind Funktionen in den Xrays von JavaScript-Object-Typen nicht sichtbar. Wenn Sie ungefilterten Zugriff auf das Original benötigen, können Sie Xrays verzichten:

// privileged scope: for example, a content script
function logUser(user) {
  // console.log(user.getUser());                 // error
  console.log(user.wrappedJSObject.getUser()); // "Bill"
}
exportFunction(logUser, window, {
  defineAs: "logUser",
});

// less-privileged scope: for example, a page script
const user = {
  getUser() {
    return "Bill";
  },
};
const test = document.getElementById("test");
test.addEventListener("click", () => {
  window.logUser(user);
});

Weitere Informationen finden Sie unter Xray vision in der Firefox-Source-Tree-Dokumentation.

Funktionen als Argumente übergeben

Wenn Funktionen als Argumente gegeben werden, werden diese ebenfalls als Xrays übergeben. Da Sie Function-Xrays wie normale Funktionen aufrufen können, funktioniert das Übergeben von Rückruffunktionen in die exportierte Funktion:

// privileged scope: for example, a content script
function logUser(getUser) {
  console.log(getUser()); // "Bill"
}
exportFunction(logUser, unsafeWindow, {
  defineAs: "logUser",
});

// less-privileged scope: for example, a page script
function getUser() {
  return "Bill";
}
const test = document.getElementById("test");
test.addEventListener("click", () => {
  window.logUser(getUser);
});

Cross-Origin-Prüfung

Wenn die exportierte Funktion aufgerufen wird, wird jedes Argument, einschließlich this, überprüft, um sicherzustellen, dass der Aufrufer dieses Argument übernimmt. Dies verhindert, dass Cross-Origin-Objekte (wie Window oder Location) an privilegierte Funktionen übergeben werden, da der privilegierte Code vollen Zugriff auf diese Objekte hat und unbeabsichtigt etwas Gefährliches tun könnte. Diese Regelung kann durch das Übergeben von { allowCrossOriginArguments: true } an exportFunction überschrieben werden.

Beispiele

Export in den globalen Kontext

Dieses Skript definiert eine Funktion und exportiert sie dann in ein Inhaltsfenster:

// extension-script.js
const salutation = "hello ";
function greetMe(user) {
  return salutation + user;
}
exportFunction(greetMe, window, { defineAs: "foo" });

Anstelle der Verwendung von defineAs kann das Skript das Ergebnis von exportFunction einem Objekt im Zielkontext zuweisen:

// extension-script.js
const salutation = "hello ";
function greetMe(user) {
  return salutation + user;
}
window.foo = exportFunction(greetMe, window);

In beiden Fällen kann der im Inhaltsfenster laufende Code die Funktion aufrufen:

// page-script.js
const greeting = foo("alice");
console.log(greeting);
// "hello alice"

Export zu einem bestehenden lokalen Objekt

Anstelle des Anhängens der Funktion an das globale window-Objekt des Ziels, kann der Aufrufer sie an ein beliebiges anderes Objekt im Zielkontext anhängen. Angenommen, das Inhaltsfenster definiert eine lokale Variable bar:

// page-script.js
const bar = {};

Nun kann das Erweiterungsskript die Funktion an bar anhängen:

// extension-script.js
exportFunction(greetMe, window.bar, {
  defineAs: "greetMe",
});

// page-script.js
const value = bar.greetMe("bob");
console.log(value);
// "hello bob"

Browser-Kompatibilität