LimiterTagAPI.md

bandcamp-fetch • Docs

---

bandcamp-fetch / LimiterTagAPI

Class: LimiterTagAPI

Extends

• TagAPI

Constructors

new LimiterTagAPI()

new LimiterTagAPI(params): LimiterTagAPI

Parameters

• params: BaseAPIWithImageSupportParams & object

Returns

LimiterTagAPI

Overrides

TagAPI.constructor

Defined in

lib/tag/TagAPI.ts:37

Accessors

cache

Get Signature

get protected cache(): Cache

Returns

Cache

Inherited from

TagAPI.cache

Defined in

lib/common/BaseAPI.ts:27

---

imageAPI

Get Signature

get imageAPI(): ImageAPI

Returns

ImageAPI

Inherited from

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

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

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

TagAPI.fetch

Defined in

lib/common/BaseAPI.ts:22

---

getRelated()

getRelated(params): Promise<RelatedTags>

Parameters

• params: TagAPIGetRelatedParams

Returns

Promise<RelatedTags>

Overrides

TagAPI.getRelated

Defined in

lib/tag/TagAPI.ts:46

---

list()

list(): Promise<TagList>

Returns

Promise<TagList>

Overrides

TagAPI.list

Defined in

lib/tag/TagAPI.ts:42