Skip to content

Latest commit

 

History

History
217 lines (109 loc) · 4.98 KB

ArticleAPI.md

File metadata and controls

217 lines (109 loc) · 4.98 KB

bandcamp-fetch • Docs

bandcamp-fetch / ArticleAPI

Class: ArticleAPI

Extends

Extended by

Constructors

new ArticleAPI()

new ArticleAPI(params): ArticleAPI

Parameters

• params: BaseAPIWithImageSupportParams

Returns

ArticleAPI

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

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

getArticle()

getArticle(params): Promise<Article>

Parameters

• params: ArticleAPIGetArticleParams

Returns

Promise<Article>

Defined in

lib/article/ArticleAPI.ts:32

getCategories()

getCategories(): Promise<ArticleCategorySection[]>

Returns

Promise<ArticleCategorySection[]>

Defined in

lib/article/ArticleAPI.ts:27

list()

list(params?): Promise<ArticleList>

Parameters

• params?: ArticleAPIListParams

Returns

Promise<ArticleList>

Defined in

lib/article/ArticleAPI.ts:44