Interface TenantosClientConfig

Configuration interface for TenantOS API client

This interface defines all the configuration options available when creating a new TenantOS client instance. All properties are readonly to ensure immutability after client creation.

Example

const config: TenantosClientConfig = {
  baseUrl: 'https://your-tenant.tenantos.com',
  apiKey: 'your-api-key-here',
  timeout: 30000,
  debug: true,
  retry: {
    attempts: 3,
    delay: 1000
  }
};

interface TenantosClientConfig {
    apiKey: string;
    baseUrl: string;
    debug?: boolean;
    headers?: Readonly<Record<string, string>>;
    retry?: { attempts: number; delay: number };
    timeout?: number;
}

Index

Properties

apiKey baseUrl debug? headers? retry? timeout?

Properties

`Readonly`apiKey

apiKey: string

API authentication token - obtain this from your TenantOS dashboard

Example

'Bearer abc123...'

`Readonly`baseUrl

baseUrl: string

Base URL of your TenantOS instance

Example

'https://your-tenant.tenantos.com'

`Optional` `Readonly`debug

debug?: boolean

Enable debug logging for requests and responses

Default

false

`Optional` `Readonly`headers

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

Custom headers to include with every request Useful for adding custom authentication or tracking headers

`Optional` `Readonly`retry

retry?: { attempts: number; delay: number }

Retry configuration for failed requests Only retryable errors (network issues, 5xx responses) will be retried

Type Declaration

Readonlyattempts: number
Number of retry attempts (0-10)
Readonlydelay: number
Delay between retries in milliseconds (0-30000)

`Optional` `Readonly`timeout

timeout?: number

Request timeout in milliseconds

Default

Minimum

1000

Maximum

300000

Interface TenantosClientConfig

Example

Index

Properties

Properties

`Readonly`apiKey

Example

`Readonly`baseUrl

Example

`Optional` `Readonly`debug

Default

`Optional` `Readonly`headers

`Optional` `Readonly`retry

Type Declaration

`Readonly`attempts: number

`Readonly`delay: number

`Optional` `Readonly`timeout

Default

Minimum

Maximum

Settings

On This Page

Interface TenantosClientConfig

Example

Index

Properties

Properties

ReadonlyapiKey

Example

ReadonlybaseUrl

Example

Optional Readonlydebug

Default

Optional Readonlyheaders

Optional Readonlyretry

Type Declaration

Readonlyattempts: number

Readonlydelay: number

Optional Readonlytimeout

Default

Minimum

Maximum

Settings

On This Page

`Readonly`apiKey

`Readonly`baseUrl

`Optional` `Readonly`debug

`Optional` `Readonly`headers

`Optional` `Readonly`retry

`Readonly`attempts: number

`Readonly`delay: number

`Optional` `Readonly`timeout