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

bandcamp-fetch / LimiterArticleAPI

Class: LimiterArticleAPI

Hierarchy

• ArticleAPI

  ↳ LimiterArticleAPI

Table of contents

Constructors

• constructor

Accessors

• cache
• imageAPI

Methods

• fetch
• getArticle
• getCategories
• list

Constructors

constructor

• new LimiterArticleAPI(params)

Parameters

Name	Type
params	BaseAPIWithImageSupportParams & { limiter: Limiter }

Overrides

ArticleAPI.constructor

Defined in

lib/article/ArticleAPI.ts:60

Accessors

cache

• Protected get cache(): Cache

Returns

Cache

Inherited from

ArticleAPI.cache

Defined in

lib/common/BaseAPI.ts:27

---

imageAPI

• get imageAPI(): ImageAPI

Returns

ImageAPI

Inherited from

ArticleAPI.imageAPI

Defined in

lib/common/BaseAPIWithImageSupport.ts:17

Methods

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

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

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

ArticleAPI.fetch

Defined in

lib/common/BaseAPI.ts:22

---

getArticle

▸ getArticle(params): Promise<Article>

Parameters

Name	Type
params	ArticleAPIGetArticleParams

Returns

Promise<Article>

Overrides

ArticleAPI.getArticle

Defined in

lib/article/ArticleAPI.ts:69

---

getCategories

▸ getCategories(): Promise<ArticleCategorySection[]>

Returns

Promise<ArticleCategorySection[]>

Overrides

ArticleAPI.getCategories

Defined in

lib/article/ArticleAPI.ts:65

---

list

▸ list(params?): Promise<ArticleList>

Parameters

Name	Type
params?	ArticleAPIListParams

Returns

Promise<ArticleList>

Inherited from

ArticleAPI.list

Defined in

lib/article/ArticleAPI.ts:43