@freedomofpress/webcat
    Preparing search index...

    Class RequestHandler

    Handles web requests and responses for specific FQDNs. Manages the entire lifecycle of a request and aggregates details such as request headers and response headers to make them available in later stages.

    Hierarchy (View Summary)

    Index
    • Returns RequestHandler

    addEventListener: (
        type: string,
        callback: EventListenerOrEventListenerObject | null,
        options?: boolean | AddEventListenerOptions,
    ) => void & (
        type: "beforerequest",
        callback: (event: RequestEvent<BeforeRequestDetails>) => void,
    ) => void & (
        type: "beforeheaders",
        callback: (event: RequestEvent<BeforeHeadersDetails>) => void,
    ) => void & (
        type: "headersreceived",
        callback: (event: RequestEvent<HeadersReceivedDetails>) => void,
    ) => void & (
        type: "erroroccurred",
        callback: (event: RequestEvent<ErrorOccurredDetails>) => void,
    ) => void & (
        type: "completed",
        callback: (event: RequestEvent<CompletedDetails>) => void,
    ) => void

    Type Declaration

      • (
            type: string,
            callback: EventListenerOrEventListenerObject | null,
            options?: boolean | AddEventListenerOptions,
        ): void
      • The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

        MDN Reference

        Parameters

        • type: string
        • callback: EventListenerOrEventListenerObject | null
        • Optionaloptions: boolean | AddEventListenerOptions

        Returns void

    • Binds the handler to the given list of FQDNs. When called, the handler starts handling requests for the FQDNs in the list and stops handling requests for any previously bound FQDNs that are not in the new list.

      Parameters

      • fqdns: string[]

        A list of fully-qualified domain names to bind to.

      Returns void

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • Returns a tuple consisting of a request filter and an optional options array, used when registering webRequest listeners. Overriding this method allows changing the registration behavior.

      Parameters

      • fqdns: string[]

        Fully-qualified domain names to handle requests for.

      • type: string

        The type of event to handle.

      Returns
          | [RequestFilter]
          | [
              RequestFilter,
              | OnBeforeRequestOptions[]
              | OnBeforeSendHeadersOptions[]
              | OnHeadersReceivedOptions[],
          ]

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

      MDN Reference

      Parameters

      • type: string
      • callback: EventListenerOrEventListenerObject | null
      • Optionaloptions: boolean | EventListenerOptions

      Returns void