Class PteroApp

Index

Constructors

Methods

getRateLimit http isApproachingRateLimit

Constructors

constructor

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

Methods

getRateLimit

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

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

http

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

isApproachingRateLimit

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

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