Home Reference Source

import RequestHandler from 'node-warc/lib/requestCapturers/requestHandler.js'

public class | source

RequestHandler

Class Responsible For Managing The Captured Request / Responses For A Page

Constructor Summary

Public Constructor
public	constructor() Create A New RequestHandler

Member Summary

Private Members
private	_capture: boolean To Capture Requests Or Not To Capture Requests
private	_requests: Map<string, CapturedRequest> Association Of RequestIds To CapturedRequests

Method Summary

Public Methods
public	[Symbol.iterator](): Iterator Get An Iterator Over The Request Id, Request Object Pairs
public	addRequestInfo(info: Object) Handles either the Network.requestWillBeSent or the Network.responseReceived events
public	clear() Remove All Requests
public	entries(): Iterator Get An Iterator Over The Request Id, Request Object Pairs
public	forEach(iteratee: function, thisArg: *) Apply An Iteratee Once For Each Mapped Request Id, Request Object Pair
public	get(requestId: string): CapturedRequest Retrieve The Corresponding Request Object For A Request Id
public	has(requestId: string): boolean Does The Interceptor Have The Request Object Associated With A Request Id
public	* iterateRequests(): Iterator<CDPRequestInfo>
public	keys(): Iterator<string> Get An Iterator Over The Request Ids
public	requestWillBeSent(info: Object) Handles the Network.requestWillBeSent event
public	responseReceived(info: Object) Handles the Network.responseReceived event
public	size(): number
public	startCapturing() Sets an internal flag to begin capturing network requests.
public	stopCapturing() Sets an internal flag to stop the capturing network requests
public	values(): Iterator<CapturedRequest> Get An Iterator Over The Request Objects

Public Constructors

public constructor() source

Create A New RequestHandler

Private Members

private _capture: boolean source

To Capture Requests Or Not To Capture Requests

private _requests: Map<string, CapturedRequest> source

Association Of RequestIds To CapturedRequests

Public Methods

public [Symbol.iterator](): Iterator source

Get An Iterator Over The Request Id, Request Object Pairs

Return:

See:

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/@@iterator

public addRequestInfo(info: Object) source

Handles either the Network.requestWillBeSent or the Network.responseReceived events

Params:

Name	Type	Attribute	Description
info	Object

See:

public clear() source

Remove All Requests

public entries(): Iterator source

Get An Iterator Over The Request Id, Request Object Pairs

Return:

public forEach(iteratee: function, thisArg: *) source

Apply An Iteratee Once For Each Mapped Request Id, Request Object Pair

Params:

Name	Type	Attribute	Description
iteratee	function	nullable: false	the function to be applied
thisArg	*	optional	optional this argument

public get(requestId: string): CapturedRequest source

Retrieve The Corresponding Request Object For A Request Id

Params:

Name	Type	Attribute	Description
requestId	string	nullable: false

Return:

CapturedRequest

public has(requestId: string): boolean source

Does The Interceptor Have The Request Object Associated With A Request Id

Params:

Name	Type	Attribute	Description
requestId	string	nullable: false

Return:

public * iterateRequests(): Iterator<CDPRequestInfo> source

Return:

Iterator<CDPRequestInfo>

public keys(): Iterator<string> source

Get An Iterator Over The Request Ids

Return:

Iterator<string>

public requestWillBeSent(info: Object) source

Handles the Network.requestWillBeSent event

Params:

Name	Type	Attribute	Description
info	Object

See:

https://chromedevtools.github.io/devtools-protocol/tot/Network/#event-requestWillBeSent

public responseReceived(info: Object) source

Handles the Network.responseReceived event

Params:

Name	Type	Attribute	Description
info	Object

See:

https://chromedevtools.github.io/devtools-protocol/tot/Network/#event-responseReceived

public size(): number source

Return:

public startCapturing() source

Sets an internal flag to begin capturing network requests. Clears Any Previously Captured Request Information

public stopCapturing() source

Sets an internal flag to stop the capturing network requests

public values(): Iterator<CapturedRequest> source

Get An Iterator Over The Request Objects

Return:

Iterator<CapturedRequest>