Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

JavaScript API

k6/http

Response

Response.submitForm( [params] )

Open source

Response.submitForm( [params] )

Fill in and submit form found in HTML of response. By default it will look for the first form tag in the HTML, but this can be overridden using the formSelector option. To set/override the form fields you set properties of an object in the fields option.

This method takes an object argument where the following properties can be set:

Param	Type	Description
formSelector	string	A selector string passed to Selection.find(selector) to locate the form to fill in and submit. By default this is `"form"`.
fields	object	The form fields to set/override. The keys are the form fields names and the values are the form field values.
submitSelector	string	A selector string used to locate the submit button in the form. By default this is `'[type="submit"]'`.
params	object	A Params (k6/http) object that will be forwarded to the form submit request. Can be used to set headers, cookies etc.

Returns

Type	Description
Response (k6/http)	The form submit response.

Example

import http from 'k6/http';
import { sleep } from 'k6';

export default function () {
  // Request page containing a form
  let res = http.get('https://httpbin.test.k6.io/forms/post');

  // Now, submit form setting/overriding some fields of the form
  res = res.submitForm({
    formSelector: 'form',
    fields: { custname: 'test', extradata: 'test2' },
  });
  sleep(3);
}