withForm #

It provides a easy way to construct a set of key/value pairs representing form fields and their values.

content-type header will be auto updated to application/x-www-form-urlencoded

Syntax #

withForm(key, value)
withForm(form-object)

• key (string) - key of the form field.
• value (string) - value of the form field.
• form-object (object) - key value pairs of form fields.

Usage #

✅ Correct Usage #

await spec()
  .post('/forms/posts')
  .withForm({
    "user": 'jon',
    "password": 'abc'
  })
  .expectStatus(201);

Examples #

const { spec } = require('pactum');

await spec()
  .post('https://httpbin.org/forms/posts')
  .withForm({
    "user": 'jon',
    "password": 'abc'
  })
  .expectStatus(201);

Notes #

• Under the hood, PactumJS uses phin.form

See Also #

• withFile
• withMultiPartFormData