Skip to content

Latest commit

 

History

History
231 lines (116 loc) · 5.58 KB

DiscoveryAPI.md

File metadata and controls

231 lines (116 loc) · 5.58 KB

bandcamp-fetch • Docs

bandcamp-fetch / DiscoveryAPI

Class: DiscoveryAPI

Extends

Extended by

Constructors

new DiscoveryAPI()

new DiscoveryAPI(params): DiscoveryAPI

Parameters

• params: BaseAPIWithImageSupportParams

Returns

DiscoveryAPI

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

discover()

discover(params?): Promise<DiscoverResult>

Parameters

• params?: DiscoverParams | DiscoverResultContinuation

Returns

Promise<DiscoverResult>

Defined in

lib/discovery/DiscoveryAPI.ts:78

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

getAvailableOptions()

getAvailableOptions(): Promise<DiscoverOptions>

Returns

Promise<DiscoverOptions>

Defined in

lib/discovery/DiscoveryAPI.ts:24

getRecommendedTagsAndLocations()

getRecommendedTagsAndLocations(): Promise<TagsAndLocations>

Returns

Promise<TagsAndLocations>

Defined in

lib/discovery/DiscoveryAPI.ts:144

sanitizeDiscoverParams()

sanitizeDiscoverParams(params?): Promise<SanitizedDiscoverParams>

Parameters

• params?: DiscoverParams

Returns

Promise<SanitizedDiscoverParams>

Defined in

lib/discovery/DiscoveryAPI.ts:31