Skip to main content

Type Alias: SignozClient

SignozClient = SignozServices & object

Defined in: src/client.ts:39

Type Declaration​

auth​

readonly auth: "api_key" | "session"

How the client authenticates.

baseUrl​

readonly baseUrl: string

The instance's normalized URL.

tokens​

readonly tokens: SessionTokens | undefined

The current token pair (changes on every rotate); undefined with an API key.

request()​

request<T>(method, path, init?): Promise<T>

A route outside the spec: always authenticates (and, with a session, rotates on 401).

Type Parameters​

T​

T = unknown

Parameters​

method​

string

path​

string

init?​

object & RequestOptions

Returns​

Promise<T>