Class PlaywrightRequest

constructor

• new PlaywrightRequest(
      args: {
          allHeaders: Effect<{ [key: string]: string }, PlaywrightError>;
          failure: () => Option<{ errorText: string }>;
          frame: Effect<PlaywrightFrameService, PlaywrightError>;
          headers: () => { [key: string]: string };
          headersArray: Effect<{ name: string; value: string }[], PlaywrightError>;
          headerValue: (name: string) => Effect<Option<string>, PlaywrightError>;
          isNavigationRequest: () => boolean;
          method: () => string;
          postData: () => Option<string>;
          postDataBuffer: () => Option<Buffer<ArrayBufferLike>>;
          postDataJSON: Effect<Option<any>, PlaywrightError>;
          redirectedFrom: () => Option<PlaywrightRequest>;
          redirectedTo: () => Option<PlaywrightRequest>;
          resourceType: () => string;
          response: Effect<Option<PlaywrightResponse>, PlaywrightError>;
          serviceWorker: () => Option<PlaywrightWorker>;
          sizes: Effect<
              {
                  requestBodySize: number;
                  requestHeadersSize: number;
                  responseBodySize: number;
                  responseHeadersSize: number;
              },
              PlaywrightError,
          >;
          timing: () => {
              connectEnd: number;
              connectStart: number;
              domainLookupEnd: number;
              domainLookupStart: number;
              requestStart: number;
              responseEnd: number;
              responseStart: number;
              secureConnectionStart: number;
              startTime: number;
          };
          url: () => string;
      },
  ): PlaywrightRequest

  Parameters

  • args: {
        allHeaders: Effect<{ [key: string]: string }, PlaywrightError>;
        failure: () => Option<{ errorText: string }>;
        frame: Effect<PlaywrightFrameService, PlaywrightError>;
        headers: () => { [key: string]: string };
        headersArray: Effect<{ name: string; value: string }[], PlaywrightError>;
        headerValue: (name: string) => Effect<Option<string>, PlaywrightError>;
        isNavigationRequest: () => boolean;
        method: () => string;
        postData: () => Option<string>;
        postDataBuffer: () => Option<Buffer<ArrayBufferLike>>;
        postDataJSON: Effect<Option<any>, PlaywrightError>;
        redirectedFrom: () => Option<PlaywrightRequest>;
        redirectedTo: () => Option<PlaywrightRequest>;
        resourceType: () => string;
        response: Effect<Option<PlaywrightResponse>, PlaywrightError>;
        serviceWorker: () => Option<PlaywrightWorker>;
        sizes: Effect<
            {
                requestBodySize: number;
                requestHeadersSize: number;
                responseBodySize: number;
                responseHeadersSize: number;
            },
            PlaywrightError,
        >;
        timing: () => {
            connectEnd: number;
            connectStart: number;
            domainLookupEnd: number;
            domainLookupStart: number;
            requestStart: number;
            responseEnd: number;
            responseStart: number;
            secureConnectionStart: number;
            startTime: number;
        };
        url: () => string;
    }

    • ReadonlyallHeaders: Effect<{ [key: string]: string }, PlaywrightError>

      An object with all the request HTTP headers associated with this request. The header names are lower-cased.

      See

      Request.allHeaders

    • Readonlyfailure: () => Option<{ errorText: string }>

      The method returns null unless this request was a failed one.

      See

      Request.failure

    • Readonlyframe: Effect<PlaywrightFrameService, PlaywrightError>

      Returns the Frame that initiated this request.

      See

      Request.frame

    • Readonlyheaders: () => { [key: string]: string }

      An object with the request HTTP headers. The header names are lower-cased.

      See

      Request.headers

    • ReadonlyheadersArray: Effect<{ name: string; value: string }[], PlaywrightError>

      An array with all the request HTTP headers associated with this request.

      See

      Request.headersArray

    • ReadonlyheaderValue: (name: string) => Effect<Option<string>, PlaywrightError>

      Returns the value of the header matching the name. The name is case insensitive.

      See

      Request.headerValue

    • ReadonlyisNavigationRequest: () => boolean

      Whether this request is driving frame's navigation.

      See

      Request.isNavigationRequest

    • Readonlymethod: () => string

      Request's method (GET, POST, etc.)

      See

      Request.method

    • ReadonlypostData: () => Option<string>

      Request's post body, if any.

      See

      Request.postData

    • ReadonlypostDataBuffer: () => Option<Buffer<ArrayBufferLike>>

      Request's post body in a binary form, if any.

      See

      Request.postDataBuffer

    • ReadonlypostDataJSON: Effect<Option<any>, PlaywrightError>

      Returns parsed request's body for form-urlencoded and JSON requests.

      See

      Request.postDataJSON

    • ReadonlyredirectedFrom: () => Option<PlaywrightRequest>

      Request that was redirected by the server to this one, if any.

      See

      Request.redirectedFrom

    • ReadonlyredirectedTo: () => Option<PlaywrightRequest>

      New request issued by the browser if the server responded with redirect.

      See

      Request.redirectedTo

    • ReadonlyresourceType: () => string

      Contains the request's resource type as it was perceived by the rendering engine.

      See

      Request.resourceType

    • Readonlyresponse: Effect<Option<PlaywrightResponse>, PlaywrightError>

      Returns the matching Response object, or null if the response was not received due to error.

      See

      Request.response

    • ReadonlyserviceWorker: () => Option<PlaywrightWorker>

      Returns the ServiceWorker that initiated this request.

      See

      Request.serviceWorker

    • Readonlysizes: Effect<
          {
              requestBodySize: number;
              requestHeadersSize: number;
              responseBodySize: number;
              responseHeadersSize: number;
          },
          PlaywrightError,
      >

      Returns resource size information for given request.

      See

      Request.sizes

    • Readonlytiming: () => {
          connectEnd: number;
          connectStart: number;
          domainLookupEnd: number;
          domainLookupStart: number;
          requestStart: number;
          responseEnd: number;
          responseStart: number;
          secureConnectionStart: number;
          startTime: number;
      }

      Returns resource timing information for given request.

      See

      Request.timing

    • Readonlyurl: () => string

      URL of the request.

      See

      Request.url

  Returns PlaywrightRequest