Class PteroClient

Index

Constructors

Methods

getRateLimit http isApproachingRateLimit

Constructors

constructor

new PteroClient(
    baseUrl: string,
    apiKey: string,
    options?: ClientOptions,
): PteroClient
Parameters
- baseUrl: string
- apiKey: string
- options: ClientOptions = {}
Returns PteroClient
- Defined in src/core/client.ts:38

Methods

getRateLimit

getRateLimit(): undefined | RateLimitInfo
Gets current rate limit information for client API

Returns undefined | RateLimitInfo
- Defined in src/core/client.ts:122

http

http(): Promise<AxiosInstance>
Returns Promise<AxiosInstance>
- Defined in src/core/client.ts:133

isApproachingRateLimit

isApproachingRateLimit(): boolean
Checks if client API is approaching rate limit

Returns boolean
- Defined in src/core/client.ts:129