withMultiPartFormData

multipart/form-data is one of the value of enctype attribute, which is used in form element that have a file upload. multi-part means form data divides into multiple parts and send to server.

content-type header will be auto updated to multipart/form-data

Syntax

withMultiPartFormData(form-data)
withMultiPartFormData(form-object)
withMultiPartFormData(key, value)
withMultiPartFormData(key, value, form-options)

key (string) - key of the form field.
value (string) - value of the form field.
form-object (object) - key value pairs of form fields.
form-data (object) - instance of form-data-lite object.
form-options (object) - key/value pairs of a FormData object.

Usage

✅ Correct Usage

// using form-data
const FormData = require('form-data-lite');
const form = new FormData();
form.append('file', fs.readFileSync('a.txt'), { filename: 'a.txt' });

await spec()
  .post('/forms/posts')
  .withMultiPartFormData(form)
  .expectStatus(201);

// pass key value pairs which uses 'form-data-lite' in the background
await spec()
  .post('/forms/posts')
  .withMultiPartFormData('file', fs.readFileSync('a.txt'), { filename: 'a.txt' })
  .expectStatus(201);

// using form-object
await spec()
  .post('/forms/posts')
  .withFile('a.txt')
  .withMultiPartFormData({
    'client': 'awk',
    'runner': 'uvu'
  })
  .expectStatus(201);

Examples

Using Form Data object

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

const FormData = require('form-data-lite');
const form = new FormData();
form.append('file', fs.readFileSync('a.txt'), { filename: 'a.txt' });

await spec()
  .post('https://httpbin.org/forms/posts')
  .withMultiPartFormData(form)
  .expectStatus(201);

Using Key Value Pairs

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

await spec()
  .post('https://httpbin.org/forms/posts')
  .withMultiPartFormData('file', fs.readFileSync('a.txt'), { filename: 'a.txt' })
  .expectStatus(201);

Notes

Under the hood, PactumJS uses form-data-lite

NOTE

From v3.1.0, pactum uses form-data-lite that has just the standard mime-types. (which reduces the overall package size). If you have a custom file type to be uploaded, you need to mention the content-type of the file explicitly.

withMultiPartFormData #

Syntax #

Usage #

✅ Correct Usage #

Examples #

Using Form Data object #

Using Key Value Pairs #

Notes #