Interface RequestConfig

Configuration for individual API requests

This interface defines the structure for making HTTP requests to the TenantOS API. It's used internally by the client but can be useful for advanced use cases.

interface RequestConfig {
    data?: unknown;
    headers?: Readonly<Record<string, string>>;
    method: HttpMethod;
    params?: Readonly<Record<string, string | number | boolean>>;
    url: string;
}

Index

Properties

data? headers? method params? url

Properties

`Optional` `Readonly`data

data?: unknown

Request body data (for POST/PUT requests)

`Optional` `Readonly`headers

headers?: Readonly<Record<string, string>>

Optional headers specific to this request

`Readonly`method

method: HttpMethod

HTTP method for the request

`Optional` `Readonly`params

params?: Readonly<Record<string, string | number | boolean>>

Query parameters to append to the URL

`Readonly`url

url: string

API endpoint URL (relative to base URL)

Interface RequestConfig

Index

Properties

Properties

`Optional` `Readonly`data

`Optional` `Readonly`headers

`Readonly`method

`Optional` `Readonly`params

`Readonly`url

Settings

On This Page

Interface RequestConfig

Index

Properties

Properties

Optional Readonlydata

Optional Readonlyheaders

Readonlymethod

Optional Readonlyparams

Readonlyurl

Settings

On This Page

`Optional` `Readonly`data

`Optional` `Readonly`headers

`Readonly`method

`Optional` `Readonly`params

`Readonly`url