LimiterShowAPI.md

bandcamp-fetch • Docs

---

bandcamp-fetch / LimiterShowAPI

Class: LimiterShowAPI

Extends

• ShowAPI

Constructors

new LimiterShowAPI()

new LimiterShowAPI(params): LimiterShowAPI

Parameters

• params: BaseAPIWithImageSupportParams & object

Returns

LimiterShowAPI

Overrides

ShowAPI.constructor

Defined in

lib/show/ShowAPI.ts:58

Accessors

cache

Get Signature

get protected cache(): Cache

Returns

Cache

Inherited from

ShowAPI.cache

Defined in

lib/common/BaseAPI.ts:27

---

imageAPI

Get Signature

get imageAPI(): ImageAPI

Returns

ImageAPI

Inherited from

ShowAPI.imageAPI

Defined in

lib/common/BaseAPIWithImageSupport.ts:17

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

Inherited from

ShowAPI.fetch

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>

Inherited from

ShowAPI.fetch

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>

Inherited from

ShowAPI.fetch

Defined in

lib/common/BaseAPI.ts:22

---

getShow()

getShow(params): Promise<Show>

Parameters

• params: ShowAPIGetShowParams

Returns

Promise<Show>

Overrides

ShowAPI.getShow

Defined in

lib/show/ShowAPI.ts:63

---

list()

list(params?): Promise<Show[]>

Parameters

• params?: ShowAPIListParams

Returns

Promise<Show[]>

Overrides

ShowAPI.list

Defined in

lib/show/ShowAPI.ts:67