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 Summary)

BaseBitBadgesApi
- BitBadgesAPI

Index

Constructors

Properties

accessToken apiKey appendedHeaders axios BACKEND_URL ConvertFunction

Methods

assertPositiveCollectionId assertPositiveInteger handleApiError setAccessToken unsetAccessToken

Constructors

constructor

new BaseBitBadgesApi<T extends NumberType>(
apiDetails: iBitBadgesApi<T>,
): BaseBitBadgesApi<T>
Type Parameters
- T extends NumberType
Parameters
- apiDetails: iBitBadgesApi<T>
Returns BaseBitBadgesApi<T>
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/base.ts:72

Properties

accessToken

accessToken: string = ''

apiKey

apiKey: undefined | string = process.env.BITBADGES_API_KEY

appendedHeaders

appendedHeaders: Record<string, string> = {}

axios

axios: AxiosInstance = ...

BACKEND_URL

BACKEND_URL: string = ...

ConvertFunction

ConvertFunction: (num: NumberType) => T

Methods

assertPositiveCollectionId

assertPositiveCollectionId(collectionId: string): void
Parameters
- collectionId: string
Returns void
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/base.ts:121

assertPositiveInteger

assertPositiveInteger(num: NumberType): void
Parameters
- num: NumberType
Returns void
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/base.ts:109

handleApiError

handleApiError(error: any): Promise<void>
Parameters
- error: any
Returns Promise<void>
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/base.ts:98

setAccessToken

setAccessToken(token: string): void
Parameters
- token: string
Returns void
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/base.ts:88

unsetAccessToken

unsetAccessToken(): void
Returns void
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/base.ts:93