Class UseAPI

Verify if the given body is equal or unequal to the given response's body.

Example

// json response
UseApi.as(actor).checkBody(response, { text: 'test' }, 'equal');
// text response
UseApi.as(actor).checkBody(response, 'test', 'unequal');
// buffer response
UseApi.as(actor).checkBody(response, Buffer.from('abc'), 'equal');
Copy

Verify if the reponse (including receiving body) was received within a given duration or not.

Example

// check if response was received within 2s
UseApi.as(actor).checkDuration(response, 2000, 'lessOrEqual');
Copy

Verify if the given headers are included/excluded in the given response. (headers should be a subset of response.headers)

Example

// check only keys
UseApi.as(actor).checkHeaders(response, { contentType: undefined }, 'included');
// check key and value
UseApi.as(actor).checkHeaders(response, { contentType: 'application/json' }, 'excluded');
Copy

Verify if the given status is equal or unequal to the given response's status.

Example

UseApi.as(actor).checkStatus(response, 200, 'equal');
Copy

Get the request context object

Send a HTTP request (GET, POST, PATCH, PUT, HEAD or DELETE) to the specified url. Headers and data can also be sent.

Example

UseApi
  .as(actor)
  .sendRequest(
    REQUEST_METHOD.POST,
    '/items', { authorization: 'Bearer dfh.dasgeq65qg.eyjkhf' },
    'json', { title: 'new item' });
Copy

Use the Ability as an Actor. Used by Actions to get access to the ability functions.

Initialize this Ability by passing an already existing Playwright APIRequestContext object.