Type Alias SendRequest

SendRequest: {
    body?: unknown;
    endpoint: string;
    headers?: { [key: string]: string };
    method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
    query?: { [key: string]: string };
    timeout?: number;
}

Request parameters for sending a network request.

Type Declaration

Optionalbody?: unknown
endpoint: string
Optionalheaders?: { [key: string]: string }
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS"
Optionalquery?: { [key: string]: string }
Optionaltimeout?: number

Example

GET request with headers:

{
  endpoint: 'https://api.example.com/users',
  method: 'GET',
  headers: { 'Authorization': 'Bearer token123' }
}

Example

POST request with body:

{
  endpoint: 'https://api.example.com/users',
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: { name: 'John Doe', email: 'john@example.com' }
}

Example

Request with query parameters and timeout:

{
  endpoint: 'https://api.example.com/search',
  method: 'GET',
  query: { q: 'grab', limit: '10' },
  timeout: 30
}

Type Alias SendRequest

Type Declaration

`Optional`body?: unknown

endpoint: string

`Optional`headers?: { [key: string]: string }

method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS"

`Optional`query?: { [key: string]: string }

`Optional`timeout?: number

Example

Example

Example

Settings

Type Alias SendRequest

Type Declaration

Optionalbody?: unknown

endpoint: string

Optionalheaders?: { [key: string]: string }

method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS"

Optionalquery?: { [key: string]: string }

Optionaltimeout?: number

Example

Example

Example

Settings

`Optional`body?: unknown

`Optional`headers?: { [key: string]: string }

`Optional`query?: { [key: string]: string }

`Optional`timeout?: number