Class: BaseBitBadgesApi<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:58

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

Extended by#

• BitBadgesAPI

Type Parameters#

T#

T extends NumberType

Constructors#

Constructor#

new BaseBitBadgesApi<T>(apiDetails): BaseBitBadgesApi<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:66

Parameters#

apiDetails#

iBitBadgesApi<T>

Returns#

BaseBitBadgesApi<T>

Properties#

accessToken#

accessToken: string = ''

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:63

---

apiKey#

apiKey: string | undefined

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:62

---

appendedHeaders#

appendedHeaders: Record<string, string> = {}

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:64

---

axios#

axios: AxiosInstance

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:59

---

BACKEND_URL#

BACKEND_URL: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:60

---

ConvertFunction#

ConvertFunction: (num) => T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:61

Parameters#

num#

NumberType

Returns#

T

Methods#

assertPositiveCollectionId()#

assertPositiveCollectionId(collectionId): void

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:118

Parameters#

collectionId#

string

Returns#

void

---

assertPositiveInteger()#

assertPositiveInteger(num): void

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:106

Parameters#

num#

NumberType

Returns#

void

---

handleApiError()#

handleApiError(error): Promise<void>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:95

Parameters#

error#

any

Returns#

Promise<void>

---

setAccessToken()#

setAccessToken(token): void

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:85

Parameters#

token#

string

Returns#

void

---

unsetAccessToken()#

unsetAccessToken(): void

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:90

Returns#

void