Interceptor

Interceptor

The interceptor is responsible for allowing customization of the batch runner behavior

Constructor

new Interceptor()

Source:

Methods

(static) instance() → {Interceptor}

Source:
Returns:
Type:
Interceptor

(async) interceptError(record, result) → {Promise.<void>}

Allows for making changes to a result after it has an error

Source:
Parameters:
Name Type Description
record Record
result Result
Returns:
Type:
Promise.<void>

Void promise

(async) interceptPostProcess(job) → {Promise.<void>}

Allows for making changes to a job after it has been processed

Source:
Parameters:
Name Type Description
job Job
Returns:
Type:
Promise.<void>

Void promise

(async) interceptPreProcess(job) → {Promise.<void>}

Allows for calling custom code before the execution of the tests begin

Source:
Parameters:
Name Type Description
job Job
Returns:
Type:
Promise.<void>

Void promise

(async) interceptRecord(record) → {Promise.<boolean>}

Allows for the input record to be manipulated before being processed

Source:
Parameters:
Name Type Description
record Record
Returns:
Type:
Promise.<boolean>

True to include the record, false to exclude it

(async) interceptRequest(record, request, device) → {Promise.<void>}

Allows for making changes to a request payload

Source:
Parameters:
Name Type Description
record Record

the record associated with this request
request Object

payload
device Device

the device making the request
Returns:
Type:
Promise.<void>

Void promise

(async) interceptResult(record, result) → {Promise.<boolean>}

Allows for making changes to a result after it has been processed

Source:
Parameters:
Name Type Description
record Record
result Result
Returns:
Type:
Promise.<boolean>

True to include the record, false to exclude it