Skip to content

Latest commit

 

History

History
183 lines (92 loc) · 3.63 KB

StreamAPI.md

File metadata and controls

183 lines (92 loc) · 3.63 KB

bandcamp-fetch • Docs

bandcamp-fetch / StreamAPI

Class: StreamAPI

Extends

Extended by

Constructors

new StreamAPI()

new StreamAPI(params): StreamAPI

Parameters

• params: BaseAPIParams

Returns

StreamAPI

Inherited from

BaseAPI.constructor

Defined in

lib/common/BaseAPI.ts:15

Accessors

cache

Get Signature

get protected cache(): Cache

Returns

Cache

Inherited from

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

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

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

BaseAPI.fetch

Defined in

lib/common/BaseAPI.ts:22

refresh()

refresh(url): Promise<null | string>

Parameters

• url: string

Returns

Promise<null | string>

Defined in

lib/stream/StreamAPI.ts:17

test()

test(url): Promise<StreamTestResult>

Parameters

• url: string

Returns

Promise<StreamTestResult>

Defined in

lib/stream/StreamAPI.ts:13