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

bandcamp-fetch / LimiterDiscoveryAPI

Class: LimiterDiscoveryAPI

Hierarchy

• DiscoveryAPI

  ↳ LimiterDiscoveryAPI

Table of contents

Constructors

• constructor

Accessors

• cache
• imageAPI

Methods

• discover
• fetch
• getAvailableOptions
• sanitizeDiscoverParams

Constructors

constructor

• new LimiterDiscoveryAPI(params)

Parameters

Name	Type
params	BaseAPIWithImageSupportParams & { limiter: Limiter }

Overrides

DiscoveryAPI.constructor

Defined in

lib/discovery/DiscoveryAPI.ts:136

Accessors

cache

• Protected get cache(): Cache

Returns

Cache

Inherited from

DiscoveryAPI.cache

Defined in

lib/common/BaseAPI.ts:27

---

imageAPI

• get imageAPI(): ImageAPI

Returns

ImageAPI

Inherited from

DiscoveryAPI.imageAPI

Defined in

lib/common/BaseAPIWithImageSupport.ts:17

Methods

discover

▸ discover(params): Promise<DiscoverResult>

Parameters

Name	Type
params	DiscoverParams

Returns

Promise<DiscoverResult>

Overrides

DiscoveryAPI.discover

Defined in

lib/discovery/DiscoveryAPI.ts:149

---

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

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

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

DiscoveryAPI.fetch

Defined in

lib/common/BaseAPI.ts:22

---

getAvailableOptions

▸ getAvailableOptions(): Promise<DiscoverOptions>

Returns

Promise<DiscoverOptions>

Overrides

DiscoveryAPI.getAvailableOptions

Defined in

lib/discovery/DiscoveryAPI.ts:141

---

sanitizeDiscoverParams

▸ sanitizeDiscoverParams(params): Promise<DiscoverParams>

Parameters

Name	Type
params	DiscoverParams

Returns

Promise<DiscoverParams>

Overrides

DiscoveryAPI.sanitizeDiscoverParams

Defined in

lib/discovery/DiscoveryAPI.ts:145