webRequest.StreamFilter.ondata
An event handler called repeatedly when response data is available. The handler is passed an Event
object with a data
property. The data
property includes a chunk of the response data as an ArrayBuffer
.
To decode the data, use either TextDecoder
or Blob
.
Without an ondata
listener, you don't receive the original response body, and the output stream is empty unless write
is called.
Examples
This example adds an ondata
listener which replaces "Example" in the response with "WebExtension Example" using the replaceAll()
method.
Note: This example only works for occurrences of "Example" that are entirely contained within a data chunk, and not ones that straddle two chunks (which might happen ~0.1% of the time for large documents). Additionally it only deals with UTF-8-coded documents. A real implementation of this would have to be more complex.
function listener(details) {
const filter = browser.webRequest.filterResponseData(details.requestId);
const decoder = new TextDecoder("utf-8");
const encoder = new TextEncoder();
filter.ondata = (event) => {
let str = decoder.decode(event.data, { stream: true });
// Just change any instance of Example in the HTTP response
// to WebExtension Example.
// Note that this will maybe not work as expected because the ending of the str can also
// be "<h1>Examp" (because it is not the full response). So, it is better
// to get the full response first and then doing the replace.
str = str.replaceAll("Example", "WebExtension Example");
filter.write(encoder.encode(str));
// Doing filter.disconnect(); here would make us process only
// the first chunk, and let the rest through unchanged. Note
// that this would break multi-byte characters that occur on
// the chunk boundary!
};
filter.onstop = (event) => {
filter.close();
};
}
browser.webRequest.onBeforeRequest.addListener(
listener,
{ urls: ["https://example.com/*"], types: ["main_frame"] },
["blocking"],
);
Another example for handling large documents:
function listener(details) {
const filter = browser.webRequest.filterResponseData(details.requestId);
const decoder = new TextDecoder("utf-8");
const encoder = new TextEncoder();
const data = [];
filter.ondata = (event) => {
data.push(event.data);
};
filter.onstop = (event) => {
let str = "";
if (data.length === 1) {
str = decoder.decode(data[0]);
} else {
for (let i = 0; i < data.length; i++) {
const stream = i !== data.length - 1;
str += decoder.decode(data[i], { stream });
}
}
str = str.replaceAll("Example", "WebExtension $&");
filter.write(encoder.encode(str));
filter.close();
};
}
browser.webRequest.onBeforeRequest.addListener(
listener,
{ urls: ["https://example.com/"], types: ["main_frame"] },
["blocking"],
);
Here's another version:
function listener(details) {
const filter = browser.webRequest.filterResponseData(details.requestId);
const decoder = new TextDecoder("utf-8");
const encoder = new TextEncoder();
const data = [];
filter.ondata = (event) => {
data.push(event.data);
};
filter.onstop = (event) => {
let str = "";
for (const buffer of data) {
str += decoder.decode(buffer, { stream: true });
}
str += decoder.decode(); // end-of-stream
str = str.replaceAll("Example", "WebExtension $&");
filter.write(encoder.encode(str));
filter.close();
};
}
browser.webRequest.onBeforeRequest.addListener(
listener,
{ urls: ["https://example.com/"], types: ["main_frame"] },
["blocking"],
);
The above example can also be written like so:
function listener(details) {
const filter = browser.webRequest.filterResponseData(details.requestId);
const decoder = new TextDecoder("utf-8");
const encoder = new TextEncoder();
const data = [];
filter.ondata = (event) => {
data.push(decoder.decode(event.data, { stream: true }));
};
filter.onstop = (event) => {
data.push(decoder.decode());
let str = data.join("");
str = str.replaceAll("Example", "WebExtension $&");
filter.write(encoder.encode(str));
filter.close();
};
}
browser.webRequest.onBeforeRequest.addListener(
listener,
{ urls: ["https://example.com/"], types: ["main_frame"] },
["blocking"],
);
This example uses a Blob
:
function listener(details) {
const filter = browser.webRequest.filterResponseData(details.requestId);
const encoder = new TextEncoder();
const data = [];
filter.ondata = (event) => {
data.push(event.data);
};
filter.onstop = async (event) => {
const blob = new Blob(data, { type: "text/html" });
let str = await blob.text();
str = str.replaceAll("Example", "WebExtension $&");
filter.write(encoder.encode(str));
filter.close();
};
}
browser.webRequest.onBeforeRequest.addListener(
listener,
{ urls: ["https://example.com/"], types: ["main_frame"] },
["blocking"],
);
This example makes use of the DOMParser
interface:
function listener(details) {
const filter = browser.webRequest.filterResponseData(details.requestId);
const encoder = new TextEncoder();
const parser = new DOMParser();
const data = [];
filter.ondata = (event) => {
data.push(event.data);
};
filter.onstop = async (event) => {
const blob = new Blob(data, { type: "text/html" });
const str = await blob.text();
const doc = parser.parseFromString(str, blob.type);
const nodes = doc.querySelectorAll("title, h1");
for (const node of nodes) {
node.innerText = node.innerText.replaceAll("Example", "WebExtension $&");
}
filter.write(encoder.encode(doc.documentElement.outerHTML));
filter.close();
};
}
browser.webRequest.onBeforeRequest.addListener(
listener,
{ urls: ["https://example.com/"], types: ["main_frame"] },
["blocking"],
);
This example combines all buffers into a single buffer:
function listener(details) {
const filter = browser.webRequest.filterResponseData(details.requestId);
const decoder = new TextDecoder("utf-8");
const encoder = new TextEncoder();
const data = [];
filter.ondata = (event) => {
data.push(new Uint8Array(event.data));
};
filter.onstop = (event) => {
let combinedLength = 0;
for (const buffer of data) {
combinedLength += buffer.length;
}
const combinedArray = new Uint8Array(combinedLength);
let writeOffset = 0;
for (const buffer of data) {
combinedArray.set(buffer, writeOffset);
writeOffset += buffer.length;
}
let str = decoder.decode(combinedArray);
str = str.replaceAll("Example", "WebExtension $&");
filter.write(encoder.encode(str));
filter.close();
};
}
browser.webRequest.onBeforeRequest.addListener(
listener,
{ urls: ["https://example.com/"], types: ["main_frame"] },
["blocking"],
);
The above example can also be written like so:
function listener(details) {
const filter = browser.webRequest.filterResponseData(details.requestId);
const decoder = new TextDecoder("utf-8");
const encoder = new TextEncoder();
const data = [];
filter.ondata = (event) => {
data.push(event.data);
};
filter.onstop = async (event) => {
const blob = new Blob(data, { type: "text/html" });
const buffer = await blob.arrayBuffer();
let str = decoder.decode(buffer);
str = str.replaceAll("Example", "WebExtension $&");
filter.write(encoder.encode(str));
filter.close();
};
}
browser.webRequest.onBeforeRequest.addListener(
listener,
{ urls: ["https://example.com/"], types: ["main_frame"] },
["blocking"],
);
This example demonstrates, how one can detect, if it's the final chunk in the response:
function listener(details) {
const filter = browser.webRequest.filterResponseData(details.requestId);
const encoder = new TextEncoder();
const decoder = new TextDecoder("utf-8");
let str = "";
filter.ondata = (event) => {
let stream = true;
const data = new Uint8Array(event.data.slice(-8, -1));
if (String.fromCharCode(...data) === "</html>") {
stream = false; // end-of-stream
}
str += decoder.decode(event.data, { stream });
};
filter.onstop = (event) => {
str = str.replaceAll("Example", "WebExtension $&");
filter.write(encoder.encode(str));
filter.close();
};
}
browser.webRequest.onBeforeRequest.addListener(
listener,
{ urls: ["https://example.com/"], types: ["main_frame"] },
["blocking"],
);
Browser compatibility
BCD tables only load in the browser