API Reference

---

API Reference / HttpClient

Class: HttpClient

Defined in: src/client/HttpClient.ts:59

Constructors

Constructor

new HttpClient(config, dependencies?): HttpClient

Defined in: src/client/HttpClient.ts:67

Parameters

config

DhanClientConfig

dependencies?

HttpClientDependencies = {}

Returns

HttpClient

Methods

request()

request<TResponse, TBody>(options): Promise<TResponse>

Defined in: src/client/HttpClient.ts:89

Type Parameters

TResponse

TResponse

TBody

TBody = unknown

Parameters

options

RequestOptions<TBody>

Returns

Promise<TResponse>

---

getCircuitState()

getCircuitState(): CircuitState | undefined

Defined in: src/client/HttpClient.ts:115

Current circuit-breaker state, mainly useful for health checks/observability.

Returns

CircuitState | undefined

---

getClientId()

getClientId(): string

Defined in: src/client/HttpClient.ts:143

Returns

string

---

getAccessToken()

getAccessToken(): Promise<string>

Defined in: src/client/HttpClient.ts:147

Returns

Promise<string>