LimiterStreamAPI.md

bandcamp-fetch • Docs

---

bandcamp-fetch / LimiterStreamAPI

Class: LimiterStreamAPI

Extends

• StreamAPI

Constructors

new LimiterStreamAPI()

new LimiterStreamAPI(params): LimiterStreamAPI

Parameters

• params: BaseAPIParams & object

Returns

LimiterStreamAPI

Overrides

StreamAPI.constructor

Defined in

lib/stream/StreamAPI.ts:32

Accessors

cache

Get Signature

get protected cache(): Cache

Returns

Cache

Inherited from

StreamAPI.cache

Defined in

lib/common/BaseAPI.ts:27

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

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

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

StreamAPI.fetch

Defined in

lib/common/BaseAPI.ts:22

---

refresh()

refresh(url): Promise<null | string>

Parameters

• url: string

Returns

Promise<null | string>

Overrides

StreamAPI.refresh

Defined in

lib/stream/StreamAPI.ts:37

---

test()

test(url): Promise<StreamTestResult>

Parameters

• url: string

Returns

Promise<StreamTestResult>

Inherited from

StreamAPI.test

Defined in

lib/stream/StreamAPI.ts:13