rq.globals (Global variables)

​

Methods

​

rq.globals.set(key, value)

• key (string): The name of the global variable
• value (any): The value to store (converted to a string). Passing null or undefined clears the variable — equivalent to unset(key), so a later get returns undefined (not the string "null").

rq.globals.set("appVersion", "1.0.0");

​

rq.globals.get(key)

• key (string): The name of the global variable to retrieve

const version = rq.globals.get("appVersion");
console.log("App Version:", version);

​

rq.globals.unset(key)

• key (string): The name of the global variable to remove

rq.globals.unset("appVersion");

​

rq.globals.clear()

rq.globals.clear();
console.log("All global variables cleared");

​

Common Use Cases

​

Store Application Version

// In setup script
rq.globals.set("appVersion", "1.0.0");
rq.globals.set("apiVersion", "v2");

// In any request
const version = rq.globals.get("appVersion");
console.log("Testing with app version:", version);

​

Track Global State

// Track total requests made
const totalRequests = parseInt(rq.globals.get("totalRequests") || "0");
rq.globals.set("totalRequests", totalRequests + 1);
console.log("Total requests made:", totalRequests + 1);

​

Store User Preferences

rq.globals.set("preferredLanguage", "en");
rq.globals.set("dateFormat", "YYYY-MM-DD");
rq.globals.set("timezone", "UTC");

​

Global Timestamp

// Set once at the beginning of a test run
rq.globals.set("testRunStartTime", Date.now());

// Reference in any request
const startTime = rq.globals.get("testRunStartTime");
const elapsed = Date.now() - parseInt(startTime);
console.log("Time since test start:", elapsed, "ms");

​

Feature Flags

// Enable/disable features globally
rq.globals.set("enableLogging", "true");
rq.globals.set("enableDebugMode", "false");
rq.globals.set("useNewEndpoint", "true");

// Check flags in any request
const debugMode = rq.globals.get("enableDebugMode") === "true";
if (debugMode) {
    console.log("Debug mode is enabled");
}

​

Store Common Constants

rq.globals.set("MAX_PAGE_SIZE", "100");
rq.globals.set("DEFAULT_PAGE_SIZE", "20");
rq.globals.set("API_KEY_HEADER", "X-API-Key");

​

Variable Scope Hierarchy

1. Global Variables (rq.globals) - Highest level, available everywhere
2. Collection Variables (rq.collectionVariables) - Available to all requests in a collection
3. Environment Variables (rq.environment) - Available to all collections in a specific environment

Environment Variables > Collection Variables > Global Variables

​

Best Practices

1. Use Sparingly: Reserve global variables for truly global data. Prefer collection or environment variables when possible.
2. Naming Convention: Use clear, uppercase names for global constants
   rq.globals.set("MAX_RETRY_ATTEMPTS", "5");
   rq.globals.set("DEFAULT_TIMEOUT_MS", "30000");
   
3. Document Purpose: Comment your global variable usage
   // Global feature flag for new API version
   rq.globals.set("useV2Api", "true");
   
4. Check Existence: Always verify a variable exists before using it
   const value = rq.globals.get("myGlobalVar");
   if (!value) {
       console.error("Global variable 'myGlobalVar' not set");
   }
   
5. Initialize Early: Set global variables in a dedicated setup script or request
6. Clean Up: Remove globals that are no longer needed
   rq.globals.unset("temporaryFlag");
   
7. Type Conversion: Remember values are stored as strings
   const maxRetries = parseInt(rq.globals.get("maxRetries") || "3");
   const enableFeature = rq.globals.get("enableFeature") === "true";
   

​

Related Documentation

• Pre-request & Post-response Scripts
• rq.sendRequest Object
• rq.execution Object
• rq.request Object
• rq.response Object
• rq.environment Object
• rq.collectionVariables Object
• rq.vault Object
• rq.test Object
• rq.expect Object