Request()
A module for performing network request to the internet that was introduced on version 1.0.0.31
Constructor
Request(url: string)
Parameters
Parameters | Type | Description |
---|---|---|
url | string | The site url can be https or http |
Methods
setHeader(key: string, value: string): Request
Set a custom header for the HTTP request.
Parameters
Parameters | Type | Description |
---|---|---|
key | string | The header name |
value | string | The header value |
Returns
Request
- Returns the Request object for method chaining
setParameter(key: string, value: string): Request
Set a parameter for the request body (used with POST/PUT requests).
Parameters
Parameters | Type | Description |
---|---|---|
key | string | The parameter name |
value | string | The parameter value |
Returns
Request
- Returns the Request object for method chaining
get(): Response
Execute a GET request and return a Response object.
Returns
Response
- The response object containing the server response
post(): Response
Execute a POST request and return a Response object.
Returns
Response
- The response object containing the server response
put(): Response
Execute a PUT request and return a Response object.
Returns
Response
- The response object containing the server response
delete(): Response
Execute a DELETE request and return a Response object.
Returns
Response
- The response object containing the server response
Examples
Basic GET Request
local response = Request("https://api.example.com/data"):get()
local data = response:getData()
local statusCode = response:getResponseCode()
POST Request with Headers and Parameters
local response = Request("https://api.example.com/users")
:setHeader("Content-Type", "application/json")
:setHeader("Authorization", "Bearer token123")
:setParameter("name", "John Doe")
:setParameter("email", "john@example.com")
:post()
Chaining Multiple Methods
-- Request objects support method chaining for fluent API
local response = Request("https://api.example.com/data")
:setHeader("API-Key", "your-api-key")
:setParameter("query", "search term")
:setParameter("limit", "10")
:get()