Route on Grafana Labs

abort([errorCode])

Mon, 21 Sep 2026 15:16:28 +0000

abort([errorCode])

Aborts the request with the given error code.

Parameter	Type	Default	Description
errorCode	string	`'failed'`	Error code when aborting the request. Can be one of the following: `'aborted'`, `'accessdenied'`, `'addressunreachable'`, `'blockedbyclient'`, `'blockedbyresponse'`, `'connectionaborted'`,`'connectionclosed'`, `'connectionfailed'`, `'connectionrefused'`, `'connectionreset'`, `'internetdisconnected'`, `'namenotresolved'`, `'timedout'`, `'failed'`.

Returns

Type	Description
`Promise<void>`	A Promise that fulfills when the request is aborted.

Example

import { browser } from 'k6/browser';

export const options = {
  scenarios: {
    browser: {
      executor: 'shared-iterations',
      options: {
        browser: {
          type: 'chromium',
        },
      },
    },
  },
};

export default async function () {
  const page = await browser.newPage();

  // Abort all images requests
  await page.route(/(\.png$)|(\.jpg$)/, async function (route) {
    await route.abort('blockedbyclient');
  });

  await page.goto('https://quickpizza.grafana.com/');

  await page.close();
}

continue([options])

Mon, 21 Sep 2026 15:16:28 +0000

continue([options])

Caution
This method has known issues, but it does work as intended. For details, refer to #5012.

Sends the request to the network with optional overrides.

Parameter	Type	Default	Description
options	object	null
options.headers	object	null	Request headers.
options.method	string	`''`	Request method (e.g. GET or POST).
options.postData	string or Buffer	`''`	Post data of the request.
options.url	string	`''`	Request URL.

Returns

Type	Description
`Promise<void>`	A Promise that fulfills when the request is resumed.

Example

import { browser } from 'k6/browser';

export const options = {
  scenarios: {
    browser: {
      executor: 'shared-iterations',
      options: {
        browser: {
          type: 'chromium',
        },
      },
    },
  },
};

export default async function () {
  const page = await browser.newPage();

  // Change the pizza request when the button is clicked
  await page.route(/.*\/pizza$/, async function (route) {
    await route.continue({
      headers: {
        ...route.request().headers(),
        foo: 'bar',
      },
      method: 'POST',
      postData: JSON.stringify({
        maxCaloriesPerSlice: 500,
        mustBeVegetarian: true,
        excludedIngredients: ['Pineapple'],
        excludedTools: ['Knife', 'Scissors'],
        maxNumberOfToppings: 1,
        minNumberOfToppings: 1,
        customName: 'Classic Pizza',
      }),
    });
  });

  await page.goto('https://quickpizza.grafana.com/');

  await page.getByRole('button', { name: 'Pizza, Please!' }).click();

  await page.close();
}

fulfill(options)

Mon, 21 Sep 2026 15:16:28 +0000

fulfill(options)

Caution
This method has known issues, but it does work as intended. For details, refer to #5012.

Fulfills the request with the given response.

Parameter	Type	Default	Description
options	object	null
options.body	string or Buffer	`''`	Response body.
options.contentType	string	`''`	Same as setting `Content-Type` response header.
options.headers	object	null	Response headers.
options.status	number	`200`	Response status code.

Returns

Type	Description
`Promise<void>`	A Promise that fulfills when the request is fulfilled.

Example

import { browser } from 'k6/browser';

export const options = {
  scenarios: {
    browser: {
      executor: 'shared-iterations',
      options: {
        browser: {
          type: 'chromium',
        },
      },
    },
  },
};

export default async function () {
  const page = await browser.newPage();

  try {
    await page.route('https://jsonplaceholder.typicode.com/todos/1', async function (route) {
      await route.fulfill({
        status: 200,
        body: JSON.stringify({
          id: 1,
          title: 'Test Todo',
          completed: false,
        }),
        contentType: 'application/json',
        headers: {
          'Access-Control-Allow-Origin': '*',
          'Access-Control-Allow-Credentials': 'true',
        },
      });
    });

    await page.goto('https://quickpizza.grafana.com/browser.php');
  } finally {
    await page.close();
  }
}

request()

Mon, 21 Sep 2026 15:16:28 +0000

request()

Returns the matching Request object.

Returns

Type	Description
`Request`	The `Request` object.

Example

import { browser } from 'k6/browser';

export const options = {
  scenarios: {
    ui: {
      executor: 'shared-iterations',
      options: {
        browser: {
          type: 'chromium',
        },
      },
    },
  },
};

export default async function () {
  const page = await browser.newPage();

  try {
    await page.route(/.*\/api\/pizza/, async function (route) {
      await route.continue({
        headers: {
          ...route.request().headers(),
          'Content-Type': 'application/json',
        },
        postData: JSON.stringify({
          customName: 'My Pizza',
        }),
      });
    });

    await page.goto('https://quickpizza.grafana.com/');
  } finally {
    await page.close();
  }
}