BaseAPI.md

bandcamp-fetch • Docs

---

bandcamp-fetch / BaseAPI

Class: abstract BaseAPI

Extended by

• BaseAPIWithImageSupport
• ImageAPI
• AutocompleteAPI
• StreamAPI

Constructors

new BaseAPI()

new BaseAPI(params): BaseAPI

Parameters

• params: BaseAPIParams

Returns

BaseAPI

Defined in

lib/common/BaseAPI.ts:15

Accessors

cache

Get Signature

get protected cache(): Cache

Returns

Cache

Defined in

lib/common/BaseAPI.ts:27

Methods

fetch()

fetch(url, jsonResponse, method, payload)

protected fetch(url, jsonResponse, method, payload?): Promise<object>

Parameters

• url: string

• jsonResponse: false

• method: HEAD

• payload?: undefined

Returns

Promise<object>

ok

ok: boolean

status

status: number

Defined in

lib/common/BaseAPI.ts:20

fetch(url, jsonResponse, method, payload)

protected fetch(url, jsonResponse, method?, payload?): Promise<any>

Parameters

• url: string

• jsonResponse: true

• method?: FetchMethod

• payload?: Record<string, any>

Returns

Promise<any>

Defined in

lib/common/BaseAPI.ts:21

fetch(url, jsonResponse, method, payload)

protected fetch(url, jsonResponse?, method?, payload?): Promise<string>

Parameters

• url: string

• jsonResponse?: boolean

• method?: FetchMethod

• payload?: Record<string, any>

Returns

Promise<string>

Defined in

lib/common/BaseAPI.ts:22