Skip to main content

WebRequestPort

WebRequestPort intercepts and observes network requests at each lifecycle stage, providing read access to request and response details in Manifest V3 contexts.

MV3 Limitation

Blocking request modification is not supported in MV3. Use DeclarativeNetRequestPort to redirect or block requests declaratively.

Context​

  • Availability: Background
  • Source: packages/ports/src/background/web-request/web-request.port.ts

API Reference Appendix​

Below is the exhaustive, auto-generated technical reference for all types, interfaces, and signatures associated with this API.

Classes​

WebRequestPort​

import { WebRequestPort } from '@hexajs-dev/ports';
class WebRequestPort { ... }

Methods​

onBeforeRequestAddListener()

onBeforeRequestAddListener(listener: (details: HexaWebWebRequestDetails) => any, filter: HexaWebWebRequestFilter, extraInfoSpec?: HexaWebWebRequestExtraInfoSpec[]): void

onBeforeRequestRemoveListener()

onBeforeRequestRemoveListener(listener: (details: HexaWebWebRequestDetails) => any): void

onBeforeSendHeadersAddListener()

onBeforeSendHeadersAddListener(listener: (details: HexaWebWebRequestDetails) => any, filter: HexaWebWebRequestFilter, extraInfoSpec?: HexaWebWebRequestExtraInfoSpec[]): void

onBeforeSendHeadersRemoveListener()

onBeforeSendHeadersRemoveListener(listener: (details: HexaWebWebRequestDetails) => any): void

onCompletedAddListener()

onCompletedAddListener(listener: (details: HexaWebWebRequestDetails) => void, filter: HexaWebWebRequestFilter): void

onCompletedRemoveListener()

onCompletedRemoveListener(listener: (details: HexaWebWebRequestDetails) => void): void

onErrorOccurredAddListener()

onErrorOccurredAddListener(listener: (details: HexaWebWebRequestDetails) => void, filter: HexaWebWebRequestFilter): void

onErrorOccurredRemoveListener()

onErrorOccurredRemoveListener(listener: (details: HexaWebWebRequestDetails) => void): void

onHeadersReceivedAddListener()

onHeadersReceivedAddListener(listener: (details: HexaWebWebRequestDetails) => any, filter: HexaWebWebRequestFilter, extraInfoSpec?: HexaWebWebRequestExtraInfoSpec[]): void

onHeadersReceivedRemoveListener()

onHeadersReceivedRemoveListener(listener: (details: HexaWebWebRequestDetails) => any): void