bandcamp-fetch/docs/api/classes/DiscoveryAPI.md

bandcamp-fetch / DiscoveryAPI

Class: DiscoveryAPI

Hierarchy

• BaseAPIWithImageSupport

  ↳ DiscoveryAPI

  ↳↳ LimiterDiscoveryAPI

Table of contents

Constructors

• constructor

Accessors

• cache
• imageAPI

Methods

• discover
• fetch
• getAvailableOptions
• sanitizeDiscoverParams

Constructors

constructor

• new DiscoveryAPI(params)

Parameters

Name	Type
params	BaseAPIWithImageSupportParams

Inherited from

BaseAPIWithImageSupport.constructor

Defined in

lib/common/BaseAPIWithImageSupport.ts:12

Accessors

cache

• Protected get cache(): Cache

Returns

Cache

Inherited from

BaseAPIWithImageSupport.cache

Defined in

lib/common/BaseAPI.ts:27

---

imageAPI

• get imageAPI(): ImageAPI

Returns

ImageAPI

Inherited from

BaseAPIWithImageSupport.imageAPI

Defined in

lib/common/BaseAPIWithImageSupport.ts:17

Methods

discover

▸ discover(params?): Promise<DiscoverResult>

Parameters

Name	Type
params?	DiscoverParams

Returns

Promise<DiscoverResult>

Defined in

lib/discovery/DiscoveryAPI.ts:76

---

fetch

▸ Protected fetch(url, jsonResponse, method, payload?): Promise<Response>

Parameters

Name	Type
url	string
jsonResponse	false
method	HEAD
payload?	undefined

Returns

Promise<Response>

Inherited from

BaseAPIWithImageSupport.fetch

Defined in

lib/common/BaseAPI.ts:20

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

Parameters

Name	Type
url	string
jsonResponse	true
method?	FetchMethod
payload?	Record<string, any>

Returns

Promise<any>

Inherited from

BaseAPIWithImageSupport.fetch

Defined in

lib/common/BaseAPI.ts:21

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

Parameters

Name	Type
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

---

sanitizeDiscoverParams

▸ sanitizeDiscoverParams(params?): Promise<DiscoverParams>

Parameters

Name	Type
params?	DiscoverParams

Returns

Promise<DiscoverParams>

Defined in

lib/discovery/DiscoveryAPI.ts:31