Keyrunner Scripting Documentation

Getting Started

To get started with Keyrunner scripting, ensure you have the necessary environment setup. Follow these steps to use various functionalities provided by Keyrunner.

Retrieve the value of an environment variable.

await kr.environment.get("<keyName>");

Set the value of an environment variable.

await kr.environment.set("<keyName>", "<value>");

Get the current request URL.

kr.request.url.get();

Set a new request URL.

kr.request.url.set("<newUrl>");

Set a request header.

kr.request.headers.set({
   key: "<keyName>",
   value: "<value>"
});

Remove a request header.

kr.request.headers.remove("<keyName>");

Get the current request method.

kr.request.method.get();

Set a new request method.

kr.request.method.set("POST");

Get the response code of the request.

kr.response.code();

Get the response headers.

kr.response.headers();

Get the response text.

kr.response.text();

Get the response in JSON format.

kr.response.json();

Log a message to KeyRunner console.

kr.console.log("Hello Keyrunner !!!");

Log an error message to KeyRunner console.

kr.console.error("Hello Keyrunner !!!");

Send a request using the specified parameters.

var request = {
    url: "<request-url>",
    method: "POST",
    header: {
        Accept: "application/json"
    },
    body: ""
};

kr.sendRequest(request, function(error, response){
    if(error){
        kr.console.error(error);
    }
    if(response){
        kr.console.log(response);
    }
});