Class BaseBitBadgesApi<T>

Base class for the BitBadges API. It provides a base axios instance and methods for handling API errors.

Type Parameters

T extends NumberType

Hierarchy (view full)

BaseBitBadgesApi
- BitBadgesAPI

Index

Constructors

Properties

BACKEND_URL ConvertFunction accessToken apiKey axios

Methods

assertPositiveInteger handleApiError setAccessToken unsetAccessToken

Constructors

constructor

new BaseBitBadgesApi<T>(apiDetails): BaseBitBadgesApi<T>
Type Parameters
- T extends NumberType
Parameters
- apiDetails: iBitBadgesApi<T>
Returns BaseBitBadgesApi<T>
- Defined in src/api-indexer/base.ts:69

Properties

BACKEND_URL

BACKEND_URL: string = ...

ConvertFunction

ConvertFunction: ((num) => T)

Type declaration

- (num): T
- Parameters
  - num: NumberType
  Returns T

accessToken

accessToken: string = ''

apiKey

apiKey: undefined | string = process.env.BITBADGES_API_KEY

axios

axios: AxiosInstance = ...

Methods

assertPositiveInteger

assertPositiveInteger(num): void
Parameters
- num: NumberType
Returns void
- Defined in src/api-indexer/base.ts:104

handleApiError

handleApiError(error): Promise<void>
Parameters
- error: any
Returns Promise<void>
- Defined in src/api-indexer/base.ts:93

setAccessToken

setAccessToken(token): void
Parameters
- token: string
Returns void
- Defined in src/api-indexer/base.ts:83

unsetAccessToken

unsetAccessToken(): void
Returns void
- Defined in src/api-indexer/base.ts:88