Skip to content

Latest commit

 

History

History
203 lines (102 loc) · 4.47 KB

ShowAPI.md

File metadata and controls

203 lines (102 loc) · 4.47 KB

bandcamp-fetch • Docs

bandcamp-fetch / ShowAPI

Class: ShowAPI

Extends

Extended by

Constructors

new ShowAPI()

new ShowAPI(params): ShowAPI

Parameters

• params: BaseAPIWithImageSupportParams

Returns

ShowAPI

Inherited from

BaseAPIWithImageSupport.constructor

Defined in

lib/common/BaseAPIWithImageSupport.ts:12

Accessors

cache

Get Signature

get protected cache(): Cache

Returns

Cache

Inherited from

BaseAPIWithImageSupport.cache

Defined in

lib/common/BaseAPI.ts:27

imageAPI

Get Signature

get imageAPI(): ImageAPI

Returns

ImageAPI

Inherited from

BaseAPIWithImageSupport.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

BaseAPIWithImageSupport.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

BaseAPIWithImageSupport.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

BaseAPIWithImageSupport.fetch

Defined in

lib/common/BaseAPI.ts:22

getShow()

getShow(params): Promise<Show>

Parameters

• params: ShowAPIGetShowParams

Returns

Promise<Show>

Defined in

lib/show/ShowAPI.ts:23

list()

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

Parameters

• params?: ShowAPIListParams

Returns

Promise<Show[]>

Defined in

lib/show/ShowAPI.ts:43