maksimgrs98/bandcamp-fetch
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add cookie support + make bcfetch instantiable

Browse Source
This commit is contained in:
patrickkfkan 2023-10-28 20:55:26 +08:00
parent 19ec315965
commit 913d4ff533
117 changed files with 4533 additions and 897 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -1,2 +1,3 @@
node_modules/
dist/
test/

52
docs/api/README.md
View File

@ -12,6 +12,7 @@ bandcamp-fetch
- [AutocompleteItemType](enums/AutocompleteItemType.md)
- [CacheDataType](enums/CacheDataType.md)
- [FetchMethod](enums/FetchMethod.md)
- [ImageFormatFilter](enums/ImageFormatFilter.md)
- [SearchItemType](enums/SearchItemType.md)
@ -21,10 +22,17 @@ bandcamp-fetch
- [ArticleAPI](classes/ArticleAPI.md)
- [AutocompleteAPI](classes/AutocompleteAPI.md)
- [BandAPI](classes/BandAPI.md)
- [BandcampFetch](classes/BandcampFetch.md)
- [BaseAPI](classes/BaseAPI.md)
- [BaseAPIWithImageSupport](classes/BaseAPIWithImageSupport.md)
- [Cache](classes/Cache.md)
- [CacheWrapper](classes/CacheWrapper.md)
- [DiscoveryAPI](classes/DiscoveryAPI.md)
- [FanAPI](classes/FanAPI.md)
- [FetchError](classes/FetchError.md)
- [Fetcher](classes/Fetcher.md)
- [ImageAPI](classes/ImageAPI.md)
- [Limiter](classes/Limiter.md)
- [LimiterAlbumAPI](classes/LimiterAlbumAPI.md)
- [LimiterArticleAPI](classes/LimiterArticleAPI.md)
- [LimiterAutocompleteAPI](classes/LimiterAutocompleteAPI.md)
@ -63,6 +71,9 @@ bandcamp-fetch
- [BandAPIGetDiscographyParams](interfaces/BandAPIGetDiscographyParams.md)
- [BandAPIGetInfoParams](interfaces/BandAPIGetInfoParams.md)
- [BandAPIGetLabelArtistsParams](interfaces/BandAPIGetLabelArtistsParams.md)
- [BandcampFetchParams](interfaces/BandcampFetchParams.md)
- [BaseAPIParams](interfaces/BaseAPIParams.md)
- [BaseAPIWithImageSupportParams](interfaces/BaseAPIWithImageSupportParams.md)
- [DiscoverOptions](interfaces/DiscoverOptions.md)
- [DiscoverParams](interfaces/DiscoverParams.md)
- [DiscoverResult](interfaces/DiscoverResult.md)
@ -72,6 +83,7 @@ bandcamp-fetch
- [FanContinuationItemsResult](interfaces/FanContinuationItemsResult.md)
- [FanItemsContinuation](interfaces/FanItemsContinuation.md)
- [FanPageItemsResult](interfaces/FanPageItemsResult.md)
- [FetcherParams](interfaces/FetcherParams.md)
- [ImageConstants](interfaces/ImageConstants.md)
- [ImageFormat](interfaces/ImageFormat.md)
- [Label](interfaces/Label.md)
@ -115,7 +127,7 @@ bandcamp-fetch
#### Defined in
[lib/types/Article.ts:51](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L51)
[lib/types/Article.ts:51](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L51)
___
@ -125,7 +137,7 @@ ___
#### Defined in
[lib/types/Label.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Label.ts#L9)
[lib/types/Label.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Label.ts#L9)
___
@ -135,44 +147,14 @@ ___
#### Defined in
[lib/types/Search.ts:47](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L47)
[lib/types/Search.ts:47](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L47)
## Variables
### default
• **default**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `album` | typeof [`AlbumAPI`](classes/AlbumAPI.md) |
| `article` | typeof [`ArticleAPI`](classes/ArticleAPI.md) |
| `autocomplete` | typeof [`AutocompleteAPI`](classes/AutocompleteAPI.md) |
| `band` | typeof [`BandAPI`](classes/BandAPI.md) |
| `cache` | typeof [`Cache`](classes/Cache.md) |
| `discovery` | typeof [`DiscoveryAPI`](classes/DiscoveryAPI.md) |
| `fan` | typeof [`FanAPI`](classes/FanAPI.md) |
| `image` | typeof [`ImageAPI`](classes/ImageAPI.md) |
| `limiter` | { `album`: typeof [`LimiterAlbumAPI`](classes/LimiterAlbumAPI.md) = LimiterAlbumAPI; `article`: typeof [`LimiterArticleAPI`](classes/LimiterArticleAPI.md) = LimiterArticleAPI; `autocomplete`: typeof [`LimiterAutocompleteAPI`](classes/LimiterAutocompleteAPI.md) = LimiterAutocompleteAPI; `band`: typeof [`LimiterBandAPI`](classes/LimiterBandAPI.md) = LimiterBandAPI; `discovery`: typeof [`LimiterDiscoveryAPI`](classes/LimiterDiscoveryAPI.md) = LimiterDiscoveryAPI; `fan`: typeof [`LimiterFanAPI`](classes/LimiterFanAPI.md) = LimiterFanAPI; `image`: typeof [`LimiterImageAPI`](classes/LimiterImageAPI.md) = LimiterImageAPI; `search`: typeof [`LimiterSearchAPI`](classes/LimiterSearchAPI.md) = LimiterSearchAPI; `show`: typeof [`LimiterShowAPI`](classes/LimiterShowAPI.md) = LimiterShowAPI; `tag`: typeof [`LimiterTagAPI`](classes/LimiterTagAPI.md) = LimiterTagAPI; `track`: typeof [`LimiterTrackAPI`](classes/LimiterTrackAPI.md) = LimiterTrackAPI; `updateSettings`: (`options?`: `ConstructorOptions`) => `void` } |
| `limiter.album` | typeof [`LimiterAlbumAPI`](classes/LimiterAlbumAPI.md) |
| `limiter.article` | typeof [`LimiterArticleAPI`](classes/LimiterArticleAPI.md) |
| `limiter.autocomplete` | typeof [`LimiterAutocompleteAPI`](classes/LimiterAutocompleteAPI.md) |
| `limiter.band` | typeof [`LimiterBandAPI`](classes/LimiterBandAPI.md) |
| `limiter.discovery` | typeof [`LimiterDiscoveryAPI`](classes/LimiterDiscoveryAPI.md) |
| `limiter.fan` | typeof [`LimiterFanAPI`](classes/LimiterFanAPI.md) |
| `limiter.image` | typeof [`LimiterImageAPI`](classes/LimiterImageAPI.md) |
| `limiter.search` | typeof [`LimiterSearchAPI`](classes/LimiterSearchAPI.md) |
| `limiter.show` | typeof [`LimiterShowAPI`](classes/LimiterShowAPI.md) |
| `limiter.tag` | typeof [`LimiterTagAPI`](classes/LimiterTagAPI.md) |
| `limiter.track` | typeof [`LimiterTrackAPI`](classes/LimiterTrackAPI.md) |
| `limiter.updateSettings` | (`options?`: `ConstructorOptions`) => `void` |
| `search` | typeof [`SearchAPI`](classes/SearchAPI.md) |
| `show` | typeof [`ShowAPI`](classes/ShowAPI.md) |
| `tag` | typeof [`TagAPI`](classes/TagAPI.md) |
| `track` | typeof [`TrackAPI`](classes/TrackAPI.md) |
• **default**: [`BandcampFetch`](classes/BandcampFetch.md)
#### Defined in
[index.ts:82](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/index.ts#L82)
[index.ts:68](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/index.ts#L68)

118
docs/api/classes/AlbumAPI.md
View File

@ -4,9 +4,11 @@
## Hierarchy
- **`AlbumAPI`**
- [`BaseAPIWithImageSupport`](BaseAPIWithImageSupport.md)
↳ [`LimiterAlbumAPI`](LimiterAlbumAPI.md)
↳ **`AlbumAPI`**
↳↳ [`LimiterAlbumAPI`](LimiterAlbumAPI.md)
## Table of contents
@ -14,21 +16,127 @@
- [constructor](AlbumAPI.md#constructor)
### Accessors
- [cache](AlbumAPI.md#cache)
- [imageAPI](AlbumAPI.md#imageapi)
### Methods
- [fetch](AlbumAPI.md#fetch)
- [getInfo](AlbumAPI.md#getinfo)
## Constructors
### constructor
• **new AlbumAPI**()
• **new AlbumAPI**(`params`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`BaseAPIWithImageSupportParams`](../interfaces/BaseAPIWithImageSupportParams.md) |
#### Inherited from
[BaseAPIWithImageSupport](BaseAPIWithImageSupport.md).[constructor](BaseAPIWithImageSupport.md#constructor)
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L12)
## Accessors
### cache
• `Protected` `get` **cache**(): [`Cache`](Cache.md)
#### Returns
[`Cache`](Cache.md)
#### Inherited from
BaseAPIWithImageSupport.cache
#### Defined in
[lib/common/BaseAPI.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L25)
___
### imageAPI
• `get` **imageAPI**(): [`ImageAPI`](ImageAPI.md)
#### Returns
[`ImageAPI`](ImageAPI.md)
#### Inherited from
BaseAPIWithImageSupport.imageAPI
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L17)
## Methods
### fetch
▸ `Protected` **fetch**(`url`, `jsonResponse`, `method?`, `payload?`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse` | ``true`` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`any`\>
#### Inherited from
[BaseAPIWithImageSupport](BaseAPIWithImageSupport.md).[fetch](BaseAPIWithImageSupport.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L19)
▸ `Protected` **fetch**(`url`, `jsonResponse?`, `method?`, `payload?`): `Promise`<`string`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse?` | `boolean` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`string`\>
#### Inherited from
[BaseAPIWithImageSupport](BaseAPIWithImageSupport.md).[fetch](BaseAPIWithImageSupport.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L20)
___
### getInfo
▸ `Static` **getInfo**(`params`): `Promise`<[`Album`](../interfaces/Album.md)\>
▸ **getInfo**(`params`): `Promise`<[`Album`](../interfaces/Album.md)\>
#### Parameters
@ -42,4 +150,4 @@
#### Defined in
[lib/album/AlbumAPI.ts:16](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/album/AlbumAPI.ts#L16)
[lib/album/AlbumAPI.ts:16](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/album/AlbumAPI.ts#L16)

126
docs/api/classes/ArticleAPI.md
View File

@ -4,9 +4,11 @@
## Hierarchy
- **`ArticleAPI`**
- [`BaseAPIWithImageSupport`](BaseAPIWithImageSupport.md)
↳ [`LimiterArticleAPI`](LimiterArticleAPI.md)
↳ **`ArticleAPI`**
↳↳ [`LimiterArticleAPI`](LimiterArticleAPI.md)
## Table of contents
@ -14,8 +16,14 @@
- [constructor](ArticleAPI.md#constructor)
### Accessors
- [cache](ArticleAPI.md#cache)
- [imageAPI](ArticleAPI.md#imageapi)
### Methods
- [fetch](ArticleAPI.md#fetch)
- [getArticle](ArticleAPI.md#getarticle)
- [getCategories](ArticleAPI.md#getcategories)
- [list](ArticleAPI.md#list)
@ -24,13 +32,113 @@
### constructor
• **new ArticleAPI**()
• **new ArticleAPI**(`params`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`BaseAPIWithImageSupportParams`](../interfaces/BaseAPIWithImageSupportParams.md) |
#### Inherited from
[BaseAPIWithImageSupport](BaseAPIWithImageSupport.md).[constructor](BaseAPIWithImageSupport.md#constructor)
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L12)
## Accessors
### cache
• `Protected` `get` **cache**(): [`Cache`](Cache.md)
#### Returns
[`Cache`](Cache.md)
#### Inherited from
BaseAPIWithImageSupport.cache
#### Defined in
[lib/common/BaseAPI.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L25)
___
### imageAPI
• `get` **imageAPI**(): [`ImageAPI`](ImageAPI.md)
#### Returns
[`ImageAPI`](ImageAPI.md)
#### Inherited from
BaseAPIWithImageSupport.imageAPI
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L17)
## Methods
### fetch
▸ `Protected` **fetch**(`url`, `jsonResponse`, `method?`, `payload?`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse` | ``true`` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`any`\>
#### Inherited from
[BaseAPIWithImageSupport](BaseAPIWithImageSupport.md).[fetch](BaseAPIWithImageSupport.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L19)
▸ `Protected` **fetch**(`url`, `jsonResponse?`, `method?`, `payload?`): `Promise`<`string`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse?` | `boolean` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`string`\>
#### Inherited from
[BaseAPIWithImageSupport](BaseAPIWithImageSupport.md).[fetch](BaseAPIWithImageSupport.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L20)
___
### getArticle
▸ `Static` **getArticle**(`params`): `Promise`<[`Article`](../interfaces/Article.md)\>
▸ **getArticle**(`params`): `Promise`<[`Article`](../interfaces/Article.md)\>
#### Parameters
@ -44,13 +152,13 @@
#### Defined in
[lib/article/ArticleAPI.ts:32](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/article/ArticleAPI.ts#L32)
[lib/article/ArticleAPI.ts:31](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/article/ArticleAPI.ts#L31)
___
### getCategories
▸ `Static` **getCategories**(): `Promise`<[`ArticleCategorySection`](../interfaces/ArticleCategorySection.md)[]\>
▸ **getCategories**(): `Promise`<[`ArticleCategorySection`](../interfaces/ArticleCategorySection.md)[]\>
#### Returns
@ -58,13 +166,13 @@ ___
#### Defined in
[lib/article/ArticleAPI.ts:27](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/article/ArticleAPI.ts#L27)
[lib/article/ArticleAPI.ts:26](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/article/ArticleAPI.ts#L26)
___
### list
▸ `Static` **list**(`params?`): `Promise`<[`ArticleList`](../interfaces/ArticleList.md)\>
▸ **list**(`params?`): `Promise`<[`ArticleList`](../interfaces/ArticleList.md)\>
#### Parameters
@ -78,4 +186,4 @@ ___
#### Defined in
[lib/article/ArticleAPI.ts:44](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/article/ArticleAPI.ts#L44)
[lib/article/ArticleAPI.ts:43](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/article/ArticleAPI.ts#L43)

107
docs/api/classes/AutocompleteAPI.md
View File

@ -4,9 +4,11 @@
## Hierarchy
- **`AutocompleteAPI`**
- [`BaseAPI`](BaseAPI.md)
↳ [`LimiterAutocompleteAPI`](LimiterAutocompleteAPI.md)
↳ **`AutocompleteAPI`**
↳↳ [`LimiterAutocompleteAPI`](LimiterAutocompleteAPI.md)
## Table of contents
@ -14,21 +16,108 @@
- [constructor](AutocompleteAPI.md#constructor)
### Accessors
- [cache](AutocompleteAPI.md#cache)
### Methods
- [fetch](AutocompleteAPI.md#fetch)
- [getSuggestions](AutocompleteAPI.md#getsuggestions)
## Constructors
### constructor
• **new AutocompleteAPI**()
• **new AutocompleteAPI**(`params`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`BaseAPIParams`](../interfaces/BaseAPIParams.md) |
#### Inherited from
[BaseAPI](BaseAPI.md).[constructor](BaseAPI.md#constructor)
#### Defined in
[lib/common/BaseAPI.ts:14](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L14)
## Accessors
### cache
• `Protected` `get` **cache**(): [`Cache`](Cache.md)
#### Returns
[`Cache`](Cache.md)
#### Inherited from
BaseAPI.cache
#### Defined in
[lib/common/BaseAPI.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L25)
## Methods
### fetch
▸ `Protected` **fetch**(`url`, `jsonResponse`, `method?`, `payload?`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse` | ``true`` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`any`\>
#### Inherited from
[BaseAPI](BaseAPI.md).[fetch](BaseAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L19)
▸ `Protected` **fetch**(`url`, `jsonResponse?`, `method?`, `payload?`): `Promise`<`string`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse?` | `boolean` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`string`\>
#### Inherited from
[BaseAPI](BaseAPI.md).[fetch](BaseAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L20)
___
### getSuggestions
▸ `Static` **getSuggestions**(`params`): `Promise`<[`AutocompleteLocation`](../interfaces/AutocompleteLocation.md)[]\>
▸ **getSuggestions**(`params`): `Promise`<[`AutocompleteLocation`](../interfaces/AutocompleteLocation.md)[]\>
#### Parameters
@ -42,9 +131,9 @@
#### Defined in
[lib/autocomplete/AutocompleteAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/autocomplete/AutocompleteAPI.ts#L20)
[lib/autocomplete/AutocompleteAPI.ts:21](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/autocomplete/AutocompleteAPI.ts#L21)
▸ `Static` **getSuggestions**(`params`): `Promise`<[`AutoCompleteTag`](../interfaces/AutoCompleteTag.md)[]\>
▸ **getSuggestions**(`params`): `Promise`<[`AutoCompleteTag`](../interfaces/AutoCompleteTag.md)[]\>
#### Parameters
@ -58,9 +147,9 @@
#### Defined in
[lib/autocomplete/AutocompleteAPI.ts:21](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/autocomplete/AutocompleteAPI.ts#L21)
[lib/autocomplete/AutocompleteAPI.ts:22](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/autocomplete/AutocompleteAPI.ts#L22)
▸ `Static` **getSuggestions**(`params`): `Promise`<[`AutoCompleteTag`](../interfaces/AutoCompleteTag.md)[] \| [`AutocompleteLocation`](../interfaces/AutocompleteLocation.md)[]\>
▸ **getSuggestions**(`params`): `Promise`<[`AutoCompleteTag`](../interfaces/AutoCompleteTag.md)[] \| [`AutocompleteLocation`](../interfaces/AutocompleteLocation.md)[]\>
#### Parameters
@ -74,4 +163,4 @@
#### Defined in
[lib/autocomplete/AutocompleteAPI.ts:22](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/autocomplete/AutocompleteAPI.ts#L22)
[lib/autocomplete/AutocompleteAPI.ts:23](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/autocomplete/AutocompleteAPI.ts#L23)

126
docs/api/classes/BandAPI.md
View File

@ -4,9 +4,11 @@
## Hierarchy
- **`BandAPI`**
- [`BaseAPIWithImageSupport`](BaseAPIWithImageSupport.md)
↳ [`LimiterBandAPI`](LimiterBandAPI.md)
↳ **`BandAPI`**
↳↳ [`LimiterBandAPI`](LimiterBandAPI.md)
## Table of contents
@ -14,8 +16,14 @@
- [constructor](BandAPI.md#constructor)
### Accessors
- [cache](BandAPI.md#cache)
- [imageAPI](BandAPI.md#imageapi)
### Methods
- [fetch](BandAPI.md#fetch)
- [getDiscography](BandAPI.md#getdiscography)
- [getInfo](BandAPI.md#getinfo)
- [getLabelArtists](BandAPI.md#getlabelartists)
@ -24,13 +32,113 @@
### constructor
• **new BandAPI**()
• **new BandAPI**(`params`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`BaseAPIWithImageSupportParams`](../interfaces/BaseAPIWithImageSupportParams.md) |
#### Inherited from
[BaseAPIWithImageSupport](BaseAPIWithImageSupport.md).[constructor](BaseAPIWithImageSupport.md#constructor)
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L12)
## Accessors
### cache
• `Protected` `get` **cache**(): [`Cache`](Cache.md)
#### Returns
[`Cache`](Cache.md)
#### Inherited from
BaseAPIWithImageSupport.cache
#### Defined in
[lib/common/BaseAPI.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L25)
___
### imageAPI
• `get` **imageAPI**(): [`ImageAPI`](ImageAPI.md)
#### Returns
[`ImageAPI`](ImageAPI.md)
#### Inherited from
BaseAPIWithImageSupport.imageAPI
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L17)
## Methods
### fetch
▸ `Protected` **fetch**(`url`, `jsonResponse`, `method?`, `payload?`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse` | ``true`` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`any`\>
#### Inherited from
[BaseAPIWithImageSupport](BaseAPIWithImageSupport.md).[fetch](BaseAPIWithImageSupport.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L19)
▸ `Protected` **fetch**(`url`, `jsonResponse?`, `method?`, `payload?`): `Promise`<`string`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse?` | `boolean` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`string`\>
#### Inherited from
[BaseAPIWithImageSupport](BaseAPIWithImageSupport.md).[fetch](BaseAPIWithImageSupport.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L20)
___
### getDiscography
▸ `Static` **getDiscography**(`params`): `Promise`<([`Track`](../interfaces/Track.md) \| [`Album`](../interfaces/Album.md))[]\>
▸ **getDiscography**(`params`): `Promise`<([`Track`](../interfaces/Track.md) \| [`Album`](../interfaces/Album.md))[]\>
#### Parameters
@ -44,13 +152,13 @@
#### Defined in
[lib/band/BandAPI.ts:32](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/band/BandAPI.ts#L32)
[lib/band/BandAPI.ts:31](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/band/BandAPI.ts#L31)
___
### getInfo
▸ `Static` **getInfo**(`params`): `Promise`<[`Label`](../interfaces/Label.md) \| [`Artist`](../interfaces/Artist.md)\>
▸ **getInfo**(`params`): `Promise`<[`Label`](../interfaces/Label.md) \| [`Artist`](../interfaces/Artist.md)\>
#### Parameters
@ -64,13 +172,13 @@ ___
#### Defined in
[lib/band/BandAPI.ts:43](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/band/BandAPI.ts#L43)
[lib/band/BandAPI.ts:42](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/band/BandAPI.ts#L42)
___
### getLabelArtists
▸ `Static` **getLabelArtists**(`params`): `Promise`<[`LabelArtist`](../README.md#labelartist)[]\>
▸ **getLabelArtists**(`params`): `Promise`<[`LabelArtist`](../README.md#labelartist)[]\>
#### Parameters
@ -84,4 +192,4 @@ ___
#### Defined in
[lib/band/BandAPI.ts:86](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/band/BandAPI.ts#L86)
[lib/band/BandAPI.ts:85](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/band/BandAPI.ts#L85)

234
docs/api/classes/BandcampFetch.md Normal file
View File

@ -0,0 +1,234 @@
[bandcamp-fetch](../README.md) / BandcampFetch
# Class: BandcampFetch
## Table of contents
### Constructors
- [constructor](BandcampFetch.md#constructor)
### Properties
- [album](BandcampFetch.md#album)
- [article](BandcampFetch.md#article)
- [autocomplete](BandcampFetch.md#autocomplete)
- [band](BandcampFetch.md#band)
- [discovery](BandcampFetch.md#discovery)
- [fan](BandcampFetch.md#fan)
- [image](BandcampFetch.md#image)
- [limiter](BandcampFetch.md#limiter)
- [search](BandcampFetch.md#search)
- [show](BandcampFetch.md#show)
- [tag](BandcampFetch.md#tag)
- [track](BandcampFetch.md#track)
### Accessors
- [cache](BandcampFetch.md#cache)
- [cookie](BandcampFetch.md#cookie)
### Methods
- [setCookie](BandcampFetch.md#setcookie)
## Constructors
### constructor
• **new BandcampFetch**(`params?`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `params?` | [`BandcampFetchParams`](../interfaces/BandcampFetchParams.md) |
#### Defined in
[lib/BandcampFetch.ts:56](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/BandcampFetch.ts#L56)
## Properties
### album
• `Readonly` **album**: [`AlbumAPI`](AlbumAPI.md)
#### Defined in
[lib/BandcampFetch.ts:29](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/BandcampFetch.ts#L29)
___
### article
• `Readonly` **article**: [`ArticleAPI`](ArticleAPI.md)
#### Defined in
[lib/BandcampFetch.ts:35](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/BandcampFetch.ts#L35)
___
### autocomplete
• `Readonly` **autocomplete**: [`AutocompleteAPI`](AutocompleteAPI.md)
#### Defined in
[lib/BandcampFetch.ts:39](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/BandcampFetch.ts#L39)
___
### band
• `Readonly` **band**: [`BandAPI`](BandAPI.md)
#### Defined in
[lib/BandcampFetch.ts:33](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/BandcampFetch.ts#L33)
___
### discovery
• `Readonly` **discovery**: [`DiscoveryAPI`](DiscoveryAPI.md)
#### Defined in
[lib/BandcampFetch.ts:31](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/BandcampFetch.ts#L31)
___
### fan
• `Readonly` **fan**: [`FanAPI`](FanAPI.md)
#### Defined in
[lib/BandcampFetch.ts:37](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/BandcampFetch.ts#L37)
___
### image
• `Readonly` **image**: [`ImageAPI`](ImageAPI.md)
#### Defined in
[lib/BandcampFetch.ts:32](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/BandcampFetch.ts#L32)
___
### limiter
• `Readonly` **limiter**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `album` | [`LimiterAlbumAPI`](LimiterAlbumAPI.md) |
| `article` | [`LimiterArticleAPI`](LimiterArticleAPI.md) |
| `autocomplete` | [`LimiterAutocompleteAPI`](LimiterAutocompleteAPI.md) |
| `band` | [`LimiterBandAPI`](LimiterBandAPI.md) |
| `discovery` | [`LimiterDiscoveryAPI`](LimiterDiscoveryAPI.md) |
| `fan` | [`LimiterFanAPI`](LimiterFanAPI.md) |
| `image` | [`LimiterImageAPI`](LimiterImageAPI.md) |
| `search` | [`LimiterSearchAPI`](LimiterSearchAPI.md) |
| `show` | [`LimiterShowAPI`](LimiterShowAPI.md) |
| `tag` | [`LimiterTagAPI`](LimiterTagAPI.md) |
| `track` | [`LimiterTrackAPI`](LimiterTrackAPI.md) |
| `updateSettings` | (`options?`: `ConstructorOptions`) => `void` |
#### Defined in
[lib/BandcampFetch.ts:41](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/BandcampFetch.ts#L41)
___
### search
• `Readonly` **search**: [`SearchAPI`](SearchAPI.md)
#### Defined in
[lib/BandcampFetch.ts:38](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/BandcampFetch.ts#L38)
___
### show
• `Readonly` **show**: [`ShowAPI`](ShowAPI.md)
#### Defined in
[lib/BandcampFetch.ts:36](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/BandcampFetch.ts#L36)
___
### tag
• `Readonly` **tag**: [`TagAPI`](TagAPI.md)
#### Defined in
[lib/BandcampFetch.ts:34](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/BandcampFetch.ts#L34)
___
### track
• `Readonly` **track**: [`TrackAPI`](TrackAPI.md)
#### Defined in
[lib/BandcampFetch.ts:30](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/BandcampFetch.ts#L30)
## Accessors
### cache
• `get` **cache**(): [`CacheWrapper`](CacheWrapper.md)
#### Returns
[`CacheWrapper`](CacheWrapper.md)
#### Defined in
[lib/BandcampFetch.ts:118](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/BandcampFetch.ts#L118)
___
### cookie
• `get` **cookie**(): `undefined` \| ``null`` \| `string`
#### Returns
`undefined` \| ``null`` \| `string`
#### Defined in
[lib/BandcampFetch.ts:114](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/BandcampFetch.ts#L114)
## Methods
### setCookie
▸ **setCookie**(`value?`): `void`
#### Parameters
| Name | Type |
| :------ | :------ |
| `value?` | ``null`` \| `string` |
#### Returns
`void`
#### Defined in
[lib/BandcampFetch.ts:109](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/BandcampFetch.ts#L109)

99
docs/api/classes/BaseAPI.md Normal file
View File

@ -0,0 +1,99 @@
[bandcamp-fetch](../README.md) / BaseAPI
# Class: BaseAPI
## Hierarchy
- **`BaseAPI`**
↳ [`BaseAPIWithImageSupport`](BaseAPIWithImageSupport.md)
↳ [`ImageAPI`](ImageAPI.md)
↳ [`AutocompleteAPI`](AutocompleteAPI.md)
## Table of contents
### Constructors
- [constructor](BaseAPI.md#constructor)
### Accessors
- [cache](BaseAPI.md#cache)
### Methods
- [fetch](BaseAPI.md#fetch)
## Constructors
### constructor
• **new BaseAPI**(`params`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`BaseAPIParams`](../interfaces/BaseAPIParams.md) |
#### Defined in
[lib/common/BaseAPI.ts:14](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L14)
## Accessors
### cache
• `Protected` `get` **cache**(): [`Cache`](Cache.md)
#### Returns
[`Cache`](Cache.md)
#### Defined in
[lib/common/BaseAPI.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L25)
## Methods
### fetch
▸ `Protected` **fetch**(`url`, `jsonResponse`, `method?`, `payload?`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse` | ``true`` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`any`\>
#### Defined in
[lib/common/BaseAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L19)
▸ `Protected` **fetch**(`url`, `jsonResponse?`, `method?`, `payload?`): `Promise`<`string`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse?` | `boolean` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`string`\>
#### Defined in
[lib/common/BaseAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L20)

144
docs/api/classes/BaseAPIWithImageSupport.md Normal file
View File

@ -0,0 +1,144 @@
[bandcamp-fetch](../README.md) / BaseAPIWithImageSupport
# Class: BaseAPIWithImageSupport
## Hierarchy
- [`BaseAPI`](BaseAPI.md)
↳ **`BaseAPIWithImageSupport`**
↳↳ [`AlbumAPI`](AlbumAPI.md)
↳↳ [`ArticleAPI`](ArticleAPI.md)
↳↳ [`BandAPI`](BandAPI.md)
↳↳ [`DiscoveryAPI`](DiscoveryAPI.md)
↳↳ [`FanAPI`](FanAPI.md)
↳↳ [`ShowAPI`](ShowAPI.md)
↳↳ [`TagAPI`](TagAPI.md)
↳↳ [`TrackAPI`](TrackAPI.md)
↳↳ [`SearchAPI`](SearchAPI.md)
## Table of contents
### Constructors
- [constructor](BaseAPIWithImageSupport.md#constructor)
### Accessors
- [cache](BaseAPIWithImageSupport.md#cache)
- [imageAPI](BaseAPIWithImageSupport.md#imageapi)
### Methods
- [fetch](BaseAPIWithImageSupport.md#fetch)
## Constructors
### constructor
• **new BaseAPIWithImageSupport**(`params`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`BaseAPIWithImageSupportParams`](../interfaces/BaseAPIWithImageSupportParams.md) |
#### Overrides
[BaseAPI](BaseAPI.md).[constructor](BaseAPI.md#constructor)
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L12)
## Accessors
### cache
• `Protected` `get` **cache**(): [`Cache`](Cache.md)
#### Returns
[`Cache`](Cache.md)
#### Inherited from
BaseAPI.cache
#### Defined in
[lib/common/BaseAPI.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L25)
___
### imageAPI
• `get` **imageAPI**(): [`ImageAPI`](ImageAPI.md)
#### Returns
[`ImageAPI`](ImageAPI.md)
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L17)
## Methods
### fetch
▸ `Protected` **fetch**(`url`, `jsonResponse`, `method?`, `payload?`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse` | ``true`` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`any`\>
#### Inherited from
[BaseAPI](BaseAPI.md).[fetch](BaseAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L19)
▸ `Protected` **fetch**(`url`, `jsonResponse?`, `method?`, `payload?`): `Promise`<`string`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse?` | `boolean` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`string`\>
#### Inherited from
[BaseAPI](BaseAPI.md).[fetch](BaseAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L20)

182
docs/api/classes/Cache.md
View File

@ -11,20 +11,37 @@
### Methods
- [clear](Cache.md#clear)
- [setMaxPages](Cache.md#setmaxpages)
- [get](Cache.md#get)
- [getKeys](Cache.md#getkeys)
- [getMaxEntries](Cache.md#getmaxentries)
- [getOrSet](Cache.md#getorset)
- [put](Cache.md#put)
- [reduceEntries](Cache.md#reduceentries)
- [setMaxEntries](Cache.md#setmaxentries)
- [setTTL](Cache.md#setttl)
## Constructors
### constructor
• **new Cache**()
• **new Cache**(`ttl`, `maxEntries`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `ttl` | `Record`<[`CacheDataType`](../enums/CacheDataType.md), `number`\> |
| `maxEntries` | `Record`<`string`, `number`\> |
#### Defined in
[lib/utils/Cache.ts:13](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/Cache.ts#L13)
## Methods
### clear
▸ `Static` **clear**(`type?`): `void`
▸ **clear**(`type?`): `void`
#### Parameters
@ -38,19 +55,143 @@
#### Defined in
[index.ts:69](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/index.ts#L69)
[lib/utils/Cache.ts:74](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/Cache.ts#L74)
___
### setMaxPages
### get
▸ `Static` **setMaxPages**(`maxPages`): `void`
▸ **get**<`T`\>(`type`, `key`): `undefined` \| `T`
#### Type parameters
| Name |
| :------ |
| `T` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `maxPages` | `number` |
| `type` | [`CacheDataType`](../enums/CacheDataType.md) |
| `key` | `string` |
#### Returns
`undefined` \| `T`
#### Defined in
[lib/utils/Cache.ts:39](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/Cache.ts#L39)
___
### getKeys
▸ **getKeys**(`type`): `string`[]
#### Parameters
| Name | Type |
| :------ | :------ |
| `type` | [`CacheDataType`](../enums/CacheDataType.md) |
#### Returns
`string`[]
#### Defined in
[lib/utils/Cache.ts:70](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/Cache.ts#L70)
___
### getMaxEntries
▸ **getMaxEntries**(`type`): `number`
#### Parameters
| Name | Type |
| :------ | :------ |
| `type` | [`CacheDataType`](../enums/CacheDataType.md) |
#### Returns
`number`
#### Defined in
[lib/utils/Cache.ts:35](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/Cache.ts#L35)
___
### getOrSet
▸ **getOrSet**<`T`\>(`type`, `key`, `promiseCallback`): `Promise`<`T`\>
#### Type parameters
| Name |
| :------ |
| `T` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `type` | [`CacheDataType`](../enums/CacheDataType.md) |
| `key` | `string` |
| `promiseCallback` | () => `Promise`<`T`\> |
#### Returns
`Promise`<`T`\>
#### Defined in
[lib/utils/Cache.ts:85](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/Cache.ts#L85)
___
### put
▸ **put**<`T`\>(`type`, `key`, `value`): `boolean`
#### Type parameters
| Name |
| :------ |
| `T` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `type` | [`CacheDataType`](../enums/CacheDataType.md) |
| `key` | `string` |
| `value` | `T` |
#### Returns
`boolean`
#### Defined in
[lib/utils/Cache.ts:43](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/Cache.ts#L43)
___
### reduceEntries
▸ **reduceEntries**(`type`, `reduceTo?`): `void`
#### Parameters
| Name | Type |
| :------ | :------ |
| `type` | [`CacheDataType`](../enums/CacheDataType.md) |
| `reduceTo?` | `number` |
#### Returns
@ -58,13 +199,34 @@ ___
#### Defined in
[index.ts:77](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/index.ts#L77)
[lib/utils/Cache.ts:58](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/Cache.ts#L58)
___
### setMaxEntries
▸ **setMaxEntries**(`type`, `maxEntries`): `void`
#### Parameters
| Name | Type |
| :------ | :------ |
| `type` | [`CacheDataType`](../enums/CacheDataType.md) |
| `maxEntries` | `number` |
#### Returns
`void`
#### Defined in
[lib/utils/Cache.ts:30](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/Cache.ts#L30)
___
### setTTL
▸ `Static` **setTTL**(`type`, `ttl`): `void`
▸ **setTTL**(`type`, `ttl`): `void`
#### Parameters
@ -79,4 +241,4 @@ ___
#### Defined in
[index.ts:73](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/index.ts#L73)
[lib/utils/Cache.ts:21](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/Cache.ts#L21)

92
docs/api/classes/CacheWrapper.md Normal file
View File

@ -0,0 +1,92 @@
[bandcamp-fetch](../README.md) / CacheWrapper
# Class: CacheWrapper
## Table of contents
### Constructors
- [constructor](CacheWrapper.md#constructor)
### Methods
- [clear](CacheWrapper.md#clear)
- [setMaxPages](CacheWrapper.md#setmaxpages)
- [setTTL](CacheWrapper.md#setttl)
## Constructors
### constructor
• **new CacheWrapper**(`cache`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `cache` | [`Cache`](Cache.md) |
#### Defined in
[lib/BandcampFetch.ts:127](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/BandcampFetch.ts#L127)
## Methods
### clear
▸ **clear**(`type?`): `void`
#### Parameters
| Name | Type |
| :------ | :------ |
| `type?` | [`CacheDataType`](../enums/CacheDataType.md) |
#### Returns
`void`
#### Defined in
[lib/BandcampFetch.ts:131](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/BandcampFetch.ts#L131)
___
### setMaxPages
▸ **setMaxPages**(`maxPages`): `void`
#### Parameters
| Name | Type |
| :------ | :------ |
| `maxPages` | `number` |
#### Returns
`void`
#### Defined in
[lib/BandcampFetch.ts:139](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/BandcampFetch.ts#L139)
___
### setTTL
▸ **setTTL**(`type`, `ttl`): `void`
#### Parameters
| Name | Type |
| :------ | :------ |
| `type` | [`CacheDataType`](../enums/CacheDataType.md) |
| `ttl` | `number` |
#### Returns
`void`
#### Defined in
[lib/BandcampFetch.ts:135](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/BandcampFetch.ts#L135)

126
docs/api/classes/DiscoveryAPI.md
View File

@ -4,9 +4,11 @@
## Hierarchy
- **`DiscoveryAPI`**
- [`BaseAPIWithImageSupport`](BaseAPIWithImageSupport.md)
↳ [`LimiterDiscoveryAPI`](LimiterDiscoveryAPI.md)
↳ **`DiscoveryAPI`**
↳↳ [`LimiterDiscoveryAPI`](LimiterDiscoveryAPI.md)
## Table of contents
@ -14,9 +16,15 @@
- [constructor](DiscoveryAPI.md#constructor)
### Accessors
- [cache](DiscoveryAPI.md#cache)
- [imageAPI](DiscoveryAPI.md#imageapi)
### Methods
- [discover](DiscoveryAPI.md#discover)
- [fetch](DiscoveryAPI.md#fetch)
- [getAvailableOptions](DiscoveryAPI.md#getavailableoptions)
- [sanitizeDiscoverParams](DiscoveryAPI.md#sanitizediscoverparams)
@ -24,13 +32,63 @@
### constructor
• **new DiscoveryAPI**()
• **new DiscoveryAPI**(`params`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`BaseAPIWithImageSupportParams`](../interfaces/BaseAPIWithImageSupportParams.md) |
#### Inherited from
[BaseAPIWithImageSupport](BaseAPIWithImageSupport.md).[constructor](BaseAPIWithImageSupport.md#constructor)
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L12)
## Accessors
### cache
• `Protected` `get` **cache**(): [`Cache`](Cache.md)
#### Returns
[`Cache`](Cache.md)
#### Inherited from
BaseAPIWithImageSupport.cache
#### Defined in
[lib/common/BaseAPI.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L25)
___
### imageAPI
• `get` **imageAPI**(): [`ImageAPI`](ImageAPI.md)
#### Returns
[`ImageAPI`](ImageAPI.md)
#### Inherited from
BaseAPIWithImageSupport.imageAPI
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L17)
## Methods
### discover
▸ `Static` **discover**(`params?`): `Promise`<[`DiscoverResult`](../interfaces/DiscoverResult.md)\>
▸ **discover**(`params?`): `Promise`<[`DiscoverResult`](../interfaces/DiscoverResult.md)\>
#### Parameters
@ -44,13 +102,63 @@
#### Defined in
[lib/discovery/DiscoveryAPI.ts:76](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/discovery/DiscoveryAPI.ts#L76)
[lib/discovery/DiscoveryAPI.ts:76](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/discovery/DiscoveryAPI.ts#L76)
___
### fetch
▸ `Protected` **fetch**(`url`, `jsonResponse`, `method?`, `payload?`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse` | ``true`` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`any`\>
#### Inherited from
[BaseAPIWithImageSupport](BaseAPIWithImageSupport.md).[fetch](BaseAPIWithImageSupport.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L19)
▸ `Protected` **fetch**(`url`, `jsonResponse?`, `method?`, `payload?`): `Promise`<`string`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse?` | `boolean` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`string`\>
#### Inherited from
[BaseAPIWithImageSupport](BaseAPIWithImageSupport.md).[fetch](BaseAPIWithImageSupport.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L20)
___
### getAvailableOptions
▸ `Static` **getAvailableOptions**(): `Promise`<[`DiscoverOptions`](../interfaces/DiscoverOptions.md)\>
▸ **getAvailableOptions**(): `Promise`<[`DiscoverOptions`](../interfaces/DiscoverOptions.md)\>
#### Returns
@ -58,13 +166,13 @@ ___
#### Defined in
[lib/discovery/DiscoveryAPI.ts:24](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/discovery/DiscoveryAPI.ts#L24)
[lib/discovery/DiscoveryAPI.ts:24](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/discovery/DiscoveryAPI.ts#L24)
___
### sanitizeDiscoverParams
▸ `Static` **sanitizeDiscoverParams**(`params?`): `Promise`<[`DiscoverParams`](../interfaces/DiscoverParams.md)\>
▸ **sanitizeDiscoverParams**(`params?`): `Promise`<[`DiscoverParams`](../interfaces/DiscoverParams.md)\>
#### Parameters
@ -78,4 +186,4 @@ ___
#### Defined in
[lib/discovery/DiscoveryAPI.ts:31](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/discovery/DiscoveryAPI.ts#L31)
[lib/discovery/DiscoveryAPI.ts:31](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/discovery/DiscoveryAPI.ts#L31)

134
docs/api/classes/FanAPI.md
View File

@ -4,9 +4,11 @@
## Hierarchy
- **`FanAPI`**
- [`BaseAPIWithImageSupport`](BaseAPIWithImageSupport.md)
↳ [`LimiterFanAPI`](LimiterFanAPI.md)
↳ **`FanAPI`**
↳↳ [`LimiterFanAPI`](LimiterFanAPI.md)
## Table of contents
@ -14,8 +16,14 @@
- [constructor](FanAPI.md#constructor)
### Accessors
- [cache](FanAPI.md#cache)
- [imageAPI](FanAPI.md#imageapi)
### Methods
- [fetch](FanAPI.md#fetch)
- [getCollection](FanAPI.md#getcollection)
- [getFollowingArtistsAndLabels](FanAPI.md#getfollowingartistsandlabels)
- [getFollowingGenres](FanAPI.md#getfollowinggenres)
@ -26,13 +34,113 @@
### constructor
• **new FanAPI**()
• **new FanAPI**(`params`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`BaseAPIWithImageSupportParams`](../interfaces/BaseAPIWithImageSupportParams.md) |
#### Inherited from
[BaseAPIWithImageSupport](BaseAPIWithImageSupport.md).[constructor](BaseAPIWithImageSupport.md#constructor)
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L12)
## Accessors
### cache
• `Protected` `get` **cache**(): [`Cache`](Cache.md)
#### Returns
[`Cache`](Cache.md)
#### Inherited from
BaseAPIWithImageSupport.cache
#### Defined in
[lib/common/BaseAPI.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L25)
___
### imageAPI
• `get` **imageAPI**(): [`ImageAPI`](ImageAPI.md)
#### Returns
[`ImageAPI`](ImageAPI.md)
#### Inherited from
BaseAPIWithImageSupport.imageAPI
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L17)
## Methods
### fetch
▸ `Protected` **fetch**(`url`, `jsonResponse`, `method?`, `payload?`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse` | ``true`` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`any`\>
#### Inherited from
[BaseAPIWithImageSupport](BaseAPIWithImageSupport.md).[fetch](BaseAPIWithImageSupport.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L19)
▸ `Protected` **fetch**(`url`, `jsonResponse?`, `method?`, `payload?`): `Promise`<`string`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse?` | `boolean` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`string`\>
#### Inherited from
[BaseAPIWithImageSupport](BaseAPIWithImageSupport.md).[fetch](BaseAPIWithImageSupport.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L20)
___
### getCollection
▸ `Static` **getCollection**(`params`): `Promise`<[`FanPageItemsResult`](../interfaces/FanPageItemsResult.md)<`NonNullable`<``null`` \| [`Track`](../interfaces/Track.md) \| [`Album`](../interfaces/Album.md)\>\> \| [`FanContinuationItemsResult`](../interfaces/FanContinuationItemsResult.md)<`NonNullable`<``null`` \| [`Track`](../interfaces/Track.md) \| [`Album`](../interfaces/Album.md)\>\>\>
▸ **getCollection**(`params`): `Promise`<[`FanPageItemsResult`](../interfaces/FanPageItemsResult.md)<`NonNullable`<``null`` \| [`Track`](../interfaces/Track.md) \| [`Album`](../interfaces/Album.md)\>\> \| [`FanContinuationItemsResult`](../interfaces/FanContinuationItemsResult.md)<`NonNullable`<``null`` \| [`Track`](../interfaces/Track.md) \| [`Album`](../interfaces/Album.md)\>\>\>
#### Parameters
@ -46,13 +154,13 @@
#### Defined in
[lib/fan/FanAPI.ts:52](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/fan/FanAPI.ts#L52)
[lib/fan/FanAPI.ts:52](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/fan/FanAPI.ts#L52)
___
### getFollowingArtistsAndLabels
▸ `Static` **getFollowingArtistsAndLabels**(`params`): `Promise`<[`FanPageItemsResult`](../interfaces/FanPageItemsResult.md)<[`UserKind`](../interfaces/UserKind.md)\> \| [`FanContinuationItemsResult`](../interfaces/FanContinuationItemsResult.md)<[`UserKind`](../interfaces/UserKind.md)\>\>
▸ **getFollowingArtistsAndLabels**(`params`): `Promise`<[`FanPageItemsResult`](../interfaces/FanPageItemsResult.md)<[`UserKind`](../interfaces/UserKind.md)\> \| [`FanContinuationItemsResult`](../interfaces/FanContinuationItemsResult.md)<[`UserKind`](../interfaces/UserKind.md)\>\>
#### Parameters
@ -66,13 +174,13 @@ ___
#### Defined in
[lib/fan/FanAPI.ts:72](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/fan/FanAPI.ts#L72)
[lib/fan/FanAPI.ts:72](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/fan/FanAPI.ts#L72)
___
### getFollowingGenres
▸ `Static` **getFollowingGenres**(`params`): `Promise`<[`FanPageItemsResult`](../interfaces/FanPageItemsResult.md)<[`Tag`](../interfaces/Tag.md)\> \| [`FanContinuationItemsResult`](../interfaces/FanContinuationItemsResult.md)<[`Tag`](../interfaces/Tag.md)\>\>
▸ **getFollowingGenres**(`params`): `Promise`<[`FanPageItemsResult`](../interfaces/FanPageItemsResult.md)<[`Tag`](../interfaces/Tag.md)\> \| [`FanContinuationItemsResult`](../interfaces/FanContinuationItemsResult.md)<[`Tag`](../interfaces/Tag.md)\>\>
#### Parameters
@ -86,13 +194,13 @@ ___
#### Defined in
[lib/fan/FanAPI.ts:82](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/fan/FanAPI.ts#L82)
[lib/fan/FanAPI.ts:82](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/fan/FanAPI.ts#L82)
___
### getInfo
▸ `Static` **getInfo**(`params`): `Promise`<[`Fan`](../interfaces/Fan.md)\>
▸ **getInfo**(`params`): `Promise`<[`Fan`](../interfaces/Fan.md)\>
#### Parameters
@ -106,13 +214,13 @@ ___
#### Defined in
[lib/fan/FanAPI.ts:41](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/fan/FanAPI.ts#L41)
[lib/fan/FanAPI.ts:41](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/fan/FanAPI.ts#L41)
___
### getWishlist
▸ `Static` **getWishlist**(`params`): `Promise`<[`FanPageItemsResult`](../interfaces/FanPageItemsResult.md)<`NonNullable`<``null`` \| [`Track`](../interfaces/Track.md) \| [`Album`](../interfaces/Album.md)\>\> \| [`FanContinuationItemsResult`](../interfaces/FanContinuationItemsResult.md)<`NonNullable`<``null`` \| [`Track`](../interfaces/Track.md) \| [`Album`](../interfaces/Album.md)\>\>\>
▸ **getWishlist**(`params`): `Promise`<[`FanPageItemsResult`](../interfaces/FanPageItemsResult.md)<`NonNullable`<``null`` \| [`Track`](../interfaces/Track.md) \| [`Album`](../interfaces/Album.md)\>\> \| [`FanContinuationItemsResult`](../interfaces/FanContinuationItemsResult.md)<`NonNullable`<``null`` \| [`Track`](../interfaces/Track.md) \| [`Album`](../interfaces/Album.md)\>\>\>
#### Parameters
@ -126,4 +234,4 @@ ___
#### Defined in
[lib/fan/FanAPI.ts:62](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/fan/FanAPI.ts#L62)
[lib/fan/FanAPI.ts:62](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/fan/FanAPI.ts#L62)

49
docs/api/classes/FetchError.md Normal file
View File

@ -0,0 +1,49 @@
[bandcamp-fetch](../README.md) / FetchError
# Class: FetchError
## Hierarchy
- `Error`
↳ **`FetchError`**
## Table of contents
### Constructors
- [constructor](FetchError.md#constructor)
### Properties
- [code](FetchError.md#code)
## Constructors
### constructor
• **new FetchError**(`payload`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | `any` |
#### Overrides
Error.constructor
#### Defined in
[lib/utils/Fetcher.ts:106](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/Fetcher.ts#L106)
## Properties
### code
• `Optional` **code**: `number`
#### Defined in
[lib/utils/Fetcher.ts:104](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/Fetcher.ts#L104)

110
docs/api/classes/Fetcher.md Normal file
View File

@ -0,0 +1,110 @@
[bandcamp-fetch](../README.md) / Fetcher
# Class: Fetcher
## Table of contents
### Constructors
- [constructor](Fetcher.md#constructor)
### Accessors
- [cookie](Fetcher.md#cookie)
### Methods
- [fetch](Fetcher.md#fetch)
- [setCookie](Fetcher.md#setcookie)
## Constructors
### constructor
• **new Fetcher**(`params`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`FetcherParams`](../interfaces/FetcherParams.md) |
#### Defined in
[lib/utils/Fetcher.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/Fetcher.ts#L20)
## Accessors
### cookie
• `get` **cookie**(): `undefined` \| ``null`` \| `string`
#### Returns
`undefined` \| ``null`` \| `string`
#### Defined in
[lib/utils/Fetcher.ts:33](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/Fetcher.ts#L33)
## Methods
### fetch
▸ **fetch**(`url`, `jsonResponse`, `method?`, `payload?`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse` | ``true`` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`any`\>
#### Defined in
[lib/utils/Fetcher.ts:37](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/Fetcher.ts#L37)
▸ **fetch**(`url`, `jsonResponse?`, `method?`, `payload?`): `Promise`<`string`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse?` | `boolean` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`string`\>
#### Defined in
[lib/utils/Fetcher.ts:38](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/Fetcher.ts#L38)
___
### setCookie
▸ **setCookie**(`value?`): `void`
#### Parameters
| Name | Type |
| :------ | :------ |
| `value?` | ``null`` \| `string` |
#### Returns
`void`
#### Defined in
[lib/utils/Fetcher.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/Fetcher.ts#L25)

103
docs/api/classes/ImageAPI.md
View File

@ -4,9 +4,11 @@
## Hierarchy
- **`ImageAPI`**
- [`BaseAPI`](BaseAPI.md)
↳ [`LimiterImageAPI`](LimiterImageAPI.md)
↳ **`ImageAPI`**
↳↳ [`LimiterImageAPI`](LimiterImageAPI.md)
## Table of contents
@ -14,8 +16,13 @@
- [constructor](ImageAPI.md#constructor)
### Accessors
- [cache](ImageAPI.md#cache)
### Methods
- [fetch](ImageAPI.md#fetch)
- [getFormat](ImageAPI.md#getformat)
- [getFormats](ImageAPI.md#getformats)
@ -23,13 +30,95 @@
### constructor
• **new ImageAPI**()
• **new ImageAPI**(`params`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`BaseAPIParams`](../interfaces/BaseAPIParams.md) |
#### Inherited from
[BaseAPI](BaseAPI.md).[constructor](BaseAPI.md#constructor)
#### Defined in
[lib/common/BaseAPI.ts:14](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L14)
## Accessors
### cache
• `Protected` `get` **cache**(): [`Cache`](Cache.md)
#### Returns
[`Cache`](Cache.md)
#### Inherited from
BaseAPI.cache
#### Defined in
[lib/common/BaseAPI.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L25)
## Methods
### fetch
▸ `Protected` **fetch**(`url`, `jsonResponse`, `method?`, `payload?`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse` | ``true`` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`any`\>
#### Inherited from
[BaseAPI](BaseAPI.md).[fetch](BaseAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L19)
▸ `Protected` **fetch**(`url`, `jsonResponse?`, `method?`, `payload?`): `Promise`<`string`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse?` | `boolean` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`string`\>
#### Inherited from
[BaseAPI](BaseAPI.md).[fetch](BaseAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L20)
___
### getFormat
▸ `Static` **getFormat**(`target?`, `fallbackId?`): `Promise`<``null`` \| [`ImageFormat`](../interfaces/ImageFormat.md)\>
▸ **getFormat**(`target?`, `fallbackId?`): `Promise`<``null`` \| [`ImageFormat`](../interfaces/ImageFormat.md)\>
#### Parameters
@ -44,13 +133,13 @@
#### Defined in
[lib/image/ImageAPI.ts:27](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/image/ImageAPI.ts#L27)
[lib/image/ImageAPI.ts:27](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/image/ImageAPI.ts#L27)
___
### getFormats
▸ `Static` **getFormats**(`filter?`): `Promise`<[`ImageFormat`](../interfaces/ImageFormat.md)[]\>
▸ **getFormats**(`filter?`): `Promise`<[`ImageFormat`](../interfaces/ImageFormat.md)[]\>
#### Parameters
@ -64,4 +153,4 @@ ___
#### Defined in
[lib/image/ImageAPI.ts:47](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/image/ImageAPI.ts#L47)
[lib/image/ImageAPI.ts:47](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/image/ImageAPI.ts#L47)

70
docs/api/classes/Limiter.md Normal file
View File

@ -0,0 +1,70 @@
[bandcamp-fetch](../README.md) / Limiter
# Class: Limiter
## Table of contents
### Constructors
- [constructor](Limiter.md#constructor)
### Methods
- [schedule](Limiter.md#schedule)
- [updateSettings](Limiter.md#updatesettings)
## Constructors
### constructor
• **new Limiter**()
#### Defined in
[lib/utils/Limiter.ts:7](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/Limiter.ts#L7)
## Methods
### schedule
▸ **schedule**<`R`\>(`fn`): `Promise`<`R`\>
#### Type parameters
| Name |
| :------ |
| `R` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `fn` | () => `PromiseLike`<`R`\> |
#### Returns
`Promise`<`R`\>
#### Defined in
[lib/utils/Limiter.ts:18](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/Limiter.ts#L18)
___
### updateSettings
▸ **updateSettings**(`options?`): `void`
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `ConstructorOptions` |
#### Returns
`void`
#### Defined in
[lib/utils/Limiter.ts:14](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/Limiter.ts#L14)

110
docs/api/classes/LimiterAlbumAPI.md
View File

@ -14,25 +14,127 @@
- [constructor](LimiterAlbumAPI.md#constructor)
### Accessors
- [cache](LimiterAlbumAPI.md#cache)
- [imageAPI](LimiterAlbumAPI.md#imageapi)
### Methods
- [fetch](LimiterAlbumAPI.md#fetch)
- [getInfo](LimiterAlbumAPI.md#getinfo)
## Constructors
### constructor
• **new LimiterAlbumAPI**()
• **new LimiterAlbumAPI**(`params`)
#### Inherited from
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`BaseAPIWithImageSupportParams`](../interfaces/BaseAPIWithImageSupportParams.md) & { `limiter`: [`Limiter`](Limiter.md) } |
#### Overrides
[AlbumAPI](AlbumAPI.md).[constructor](AlbumAPI.md#constructor)
#### Defined in
[lib/album/AlbumAPI.ts:33](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/album/AlbumAPI.ts#L33)
## Accessors
### cache
• `Protected` `get` **cache**(): [`Cache`](Cache.md)
#### Returns
[`Cache`](Cache.md)
#### Inherited from
AlbumAPI.cache
#### Defined in
[lib/common/BaseAPI.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L25)
___
### imageAPI
• `get` **imageAPI**(): [`ImageAPI`](ImageAPI.md)
#### Returns
[`ImageAPI`](ImageAPI.md)
#### Inherited from
AlbumAPI.imageAPI
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L17)
## Methods
### fetch
▸ `Protected` **fetch**(`url`, `jsonResponse`, `method?`, `payload?`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse` | ``true`` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`any`\>
#### Inherited from
[AlbumAPI](AlbumAPI.md).[fetch](AlbumAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L19)
▸ `Protected` **fetch**(`url`, `jsonResponse?`, `method?`, `payload?`): `Promise`<`string`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse?` | `boolean` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`string`\>
#### Inherited from
[AlbumAPI](AlbumAPI.md).[fetch](AlbumAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L20)
___
### getInfo
▸ `Static` **getInfo**(`params`): `Promise`<[`Album`](../interfaces/Album.md)\>
▸ **getInfo**(`params`): `Promise`<[`Album`](../interfaces/Album.md)\>
#### Parameters
@ -50,4 +152,4 @@
#### Defined in
[lib/album/AlbumAPI.ts:30](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/album/AlbumAPI.ts#L30)
[lib/album/AlbumAPI.ts:38](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/album/AlbumAPI.ts#L38)

118
docs/api/classes/LimiterArticleAPI.md
View File

@ -14,8 +14,14 @@
- [constructor](LimiterArticleAPI.md#constructor)
### Accessors
- [cache](LimiterArticleAPI.md#cache)
- [imageAPI](LimiterArticleAPI.md#imageapi)
### Methods
- [fetch](LimiterArticleAPI.md#fetch)
- [getArticle](LimiterArticleAPI.md#getarticle)
- [getCategories](LimiterArticleAPI.md#getcategories)
- [list](LimiterArticleAPI.md#list)
@ -24,17 +30,113 @@
### constructor
• **new LimiterArticleAPI**()
• **new LimiterArticleAPI**(`params`)
#### Inherited from
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`BaseAPIWithImageSupportParams`](../interfaces/BaseAPIWithImageSupportParams.md) & { `limiter`: [`Limiter`](Limiter.md) } |
#### Overrides
[ArticleAPI](ArticleAPI.md).[constructor](ArticleAPI.md#constructor)
#### Defined in
[lib/article/ArticleAPI.ts:60](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/article/ArticleAPI.ts#L60)
## Accessors
### cache
• `Protected` `get` **cache**(): [`Cache`](Cache.md)
#### Returns
[`Cache`](Cache.md)
#### Inherited from
ArticleAPI.cache
#### Defined in
[lib/common/BaseAPI.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L25)
___
### imageAPI
• `get` **imageAPI**(): [`ImageAPI`](ImageAPI.md)
#### Returns
[`ImageAPI`](ImageAPI.md)
#### Inherited from
ArticleAPI.imageAPI
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L17)
## Methods
### fetch
▸ `Protected` **fetch**(`url`, `jsonResponse`, `method?`, `payload?`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse` | ``true`` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`any`\>
#### Inherited from
[ArticleAPI](ArticleAPI.md).[fetch](ArticleAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L19)
▸ `Protected` **fetch**(`url`, `jsonResponse?`, `method?`, `payload?`): `Promise`<`string`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse?` | `boolean` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`string`\>
#### Inherited from
[ArticleAPI](ArticleAPI.md).[fetch](ArticleAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L20)
___
### getArticle
▸ `Static` **getArticle**(`params`): `Promise`<[`Article`](../interfaces/Article.md)\>
▸ **getArticle**(`params`): `Promise`<[`Article`](../interfaces/Article.md)\>
#### Parameters
@ -52,13 +154,13 @@
#### Defined in
[lib/article/ArticleAPI.ts:63](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/article/ArticleAPI.ts#L63)
[lib/article/ArticleAPI.ts:69](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/article/ArticleAPI.ts#L69)
___
### getCategories
▸ `Static` **getCategories**(): `Promise`<[`ArticleCategorySection`](../interfaces/ArticleCategorySection.md)[]\>
▸ **getCategories**(): `Promise`<[`ArticleCategorySection`](../interfaces/ArticleCategorySection.md)[]\>
#### Returns
@ -70,13 +172,13 @@ ___
#### Defined in
[lib/article/ArticleAPI.ts:59](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/article/ArticleAPI.ts#L59)
[lib/article/ArticleAPI.ts:65](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/article/ArticleAPI.ts#L65)
___
### list
▸ `Static` **list**(`params?`): `Promise`<[`ArticleList`](../interfaces/ArticleList.md)\>
▸ **list**(`params?`): `Promise`<[`ArticleList`](../interfaces/ArticleList.md)\>
#### Parameters
@ -94,4 +196,4 @@ ___
#### Defined in
[lib/article/ArticleAPI.ts:44](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/article/ArticleAPI.ts#L44)
[lib/article/ArticleAPI.ts:43](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/article/ArticleAPI.ts#L43)

99
docs/api/classes/LimiterAutocompleteAPI.md
View File

@ -14,25 +14,108 @@
- [constructor](LimiterAutocompleteAPI.md#constructor)
### Accessors
- [cache](LimiterAutocompleteAPI.md#cache)
### Methods
- [fetch](LimiterAutocompleteAPI.md#fetch)
- [getSuggestions](LimiterAutocompleteAPI.md#getsuggestions)
## Constructors
### constructor
• **new LimiterAutocompleteAPI**()
• **new LimiterAutocompleteAPI**(`params`)
#### Inherited from
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`BaseAPIParams`](../interfaces/BaseAPIParams.md) & { `limiter`: [`Limiter`](Limiter.md) } |
#### Overrides
[AutocompleteAPI](AutocompleteAPI.md).[constructor](AutocompleteAPI.md#constructor)
#### Defined in
[lib/autocomplete/AutocompleteAPI.ts:64](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/autocomplete/AutocompleteAPI.ts#L64)
## Accessors
### cache
• `Protected` `get` **cache**(): [`Cache`](Cache.md)
#### Returns
[`Cache`](Cache.md)
#### Inherited from
AutocompleteAPI.cache
#### Defined in
[lib/common/BaseAPI.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L25)
## Methods
### fetch
▸ `Protected` **fetch**(`url`, `jsonResponse`, `method?`, `payload?`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse` | ``true`` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`any`\>
#### Inherited from
[AutocompleteAPI](AutocompleteAPI.md).[fetch](AutocompleteAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L19)
▸ `Protected` **fetch**(`url`, `jsonResponse?`, `method?`, `payload?`): `Promise`<`string`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse?` | `boolean` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`string`\>
#### Inherited from
[AutocompleteAPI](AutocompleteAPI.md).[fetch](AutocompleteAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L20)
___
### getSuggestions
▸ `Static` **getSuggestions**(`params`): `Promise`<[`AutocompleteLocation`](../interfaces/AutocompleteLocation.md)[]\>
▸ **getSuggestions**(`params`): `Promise`<[`AutocompleteLocation`](../interfaces/AutocompleteLocation.md)[]\>
#### Parameters
@ -50,9 +133,9 @@
#### Defined in
[lib/autocomplete/AutocompleteAPI.ts:61](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/autocomplete/AutocompleteAPI.ts#L61)
[lib/autocomplete/AutocompleteAPI.ts:69](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/autocomplete/AutocompleteAPI.ts#L69)
▸ `Static` **getSuggestions**(`params`): `Promise`<[`AutoCompleteTag`](../interfaces/AutoCompleteTag.md)[]\>
▸ **getSuggestions**(`params`): `Promise`<[`AutoCompleteTag`](../interfaces/AutoCompleteTag.md)[]\>
#### Parameters
@ -70,9 +153,9 @@
#### Defined in
[lib/autocomplete/AutocompleteAPI.ts:62](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/autocomplete/AutocompleteAPI.ts#L62)
[lib/autocomplete/AutocompleteAPI.ts:70](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/autocomplete/AutocompleteAPI.ts#L70)
▸ `Static` **getSuggestions**(`params`): `Promise`<[`AutoCompleteTag`](../interfaces/AutoCompleteTag.md)[] \| [`AutocompleteLocation`](../interfaces/AutocompleteLocation.md)[]\>
▸ **getSuggestions**(`params`): `Promise`<[`AutoCompleteTag`](../interfaces/AutoCompleteTag.md)[] \| [`AutocompleteLocation`](../interfaces/AutocompleteLocation.md)[]\>
#### Parameters
@ -90,4 +173,4 @@
#### Defined in
[lib/autocomplete/AutocompleteAPI.ts:63](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/autocomplete/AutocompleteAPI.ts#L63)
[lib/autocomplete/AutocompleteAPI.ts:71](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/autocomplete/AutocompleteAPI.ts#L71)

118
docs/api/classes/LimiterBandAPI.md
View File

@ -14,8 +14,14 @@
- [constructor](LimiterBandAPI.md#constructor)
### Accessors
- [cache](LimiterBandAPI.md#cache)
- [imageAPI](LimiterBandAPI.md#imageapi)
### Methods
- [fetch](LimiterBandAPI.md#fetch)
- [getDiscography](LimiterBandAPI.md#getdiscography)
- [getInfo](LimiterBandAPI.md#getinfo)
- [getLabelArtists](LimiterBandAPI.md#getlabelartists)
@ -24,17 +30,113 @@
### constructor
• **new LimiterBandAPI**()
• **new LimiterBandAPI**(`params`)
#### Inherited from
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`BaseAPIWithImageSupportParams`](../interfaces/BaseAPIWithImageSupportParams.md) & { `limiter`: [`Limiter`](Limiter.md) } |
#### Overrides
[BandAPI](BandAPI.md).[constructor](BandAPI.md#constructor)
#### Defined in
[lib/band/BandAPI.ts:136](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/band/BandAPI.ts#L136)
## Accessors
### cache
• `Protected` `get` **cache**(): [`Cache`](Cache.md)
#### Returns
[`Cache`](Cache.md)
#### Inherited from
BandAPI.cache
#### Defined in
[lib/common/BaseAPI.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L25)
___
### imageAPI
• `get` **imageAPI**(): [`ImageAPI`](ImageAPI.md)
#### Returns
[`ImageAPI`](ImageAPI.md)
#### Inherited from
BandAPI.imageAPI
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L17)
## Methods
### fetch
▸ `Protected` **fetch**(`url`, `jsonResponse`, `method?`, `payload?`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse` | ``true`` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`any`\>
#### Inherited from
[BandAPI](BandAPI.md).[fetch](BandAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L19)
▸ `Protected` **fetch**(`url`, `jsonResponse?`, `method?`, `payload?`): `Promise`<`string`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse?` | `boolean` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`string`\>
#### Inherited from
[BandAPI](BandAPI.md).[fetch](BandAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L20)
___
### getDiscography
▸ `Static` **getDiscography**(`params`): `Promise`<([`Track`](../interfaces/Track.md) \| [`Album`](../interfaces/Album.md))[]\>
▸ **getDiscography**(`params`): `Promise`<([`Track`](../interfaces/Track.md) \| [`Album`](../interfaces/Album.md))[]\>
#### Parameters
@ -52,13 +154,13 @@
#### Defined in
[lib/band/BandAPI.ts:135](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/band/BandAPI.ts#L135)
[lib/band/BandAPI.ts:141](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/band/BandAPI.ts#L141)
___
### getInfo
▸ `Static` **getInfo**(`params`): `Promise`<[`Label`](../interfaces/Label.md) \| [`Artist`](../interfaces/Artist.md)\>
▸ **getInfo**(`params`): `Promise`<[`Label`](../interfaces/Label.md) \| [`Artist`](../interfaces/Artist.md)\>
#### Parameters
@ -76,13 +178,13 @@ ___
#### Defined in
[lib/band/BandAPI.ts:139](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/band/BandAPI.ts#L139)
[lib/band/BandAPI.ts:145](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/band/BandAPI.ts#L145)
___
### getLabelArtists
▸ `Static` **getLabelArtists**(`params`): `Promise`<[`LabelArtist`](../README.md#labelartist)[]\>
▸ **getLabelArtists**(`params`): `Promise`<[`LabelArtist`](../README.md#labelartist)[]\>
#### Parameters
@ -100,4 +202,4 @@ ___
#### Defined in
[lib/band/BandAPI.ts:143](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/band/BandAPI.ts#L143)
[lib/band/BandAPI.ts:149](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/band/BandAPI.ts#L149)

118
docs/api/classes/LimiterDiscoveryAPI.md
View File

@ -14,9 +14,15 @@
- [constructor](LimiterDiscoveryAPI.md#constructor)
### Accessors
- [cache](LimiterDiscoveryAPI.md#cache)
- [imageAPI](LimiterDiscoveryAPI.md#imageapi)
### Methods
- [discover](LimiterDiscoveryAPI.md#discover)
- [fetch](LimiterDiscoveryAPI.md#fetch)
- [getAvailableOptions](LimiterDiscoveryAPI.md#getavailableoptions)
- [sanitizeDiscoverParams](LimiterDiscoveryAPI.md#sanitizediscoverparams)
@ -24,17 +30,63 @@
### constructor
• **new LimiterDiscoveryAPI**()
• **new LimiterDiscoveryAPI**(`params`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`BaseAPIWithImageSupportParams`](../interfaces/BaseAPIWithImageSupportParams.md) & { `limiter`: [`Limiter`](Limiter.md) } |
#### Overrides
[DiscoveryAPI](DiscoveryAPI.md).[constructor](DiscoveryAPI.md#constructor)
#### Defined in
[lib/discovery/DiscoveryAPI.ts:136](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/discovery/DiscoveryAPI.ts#L136)
## Accessors
### cache
• `Protected` `get` **cache**(): [`Cache`](Cache.md)
#### Returns
[`Cache`](Cache.md)
#### Inherited from
[DiscoveryAPI](DiscoveryAPI.md).[constructor](DiscoveryAPI.md#constructor)
DiscoveryAPI.cache
#### Defined in
[lib/common/BaseAPI.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L25)
___
### imageAPI
• `get` **imageAPI**(): [`ImageAPI`](ImageAPI.md)
#### Returns
[`ImageAPI`](ImageAPI.md)
#### Inherited from
DiscoveryAPI.imageAPI
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L17)
## Methods
### discover
▸ `Static` **discover**(`params`): `Promise`<[`DiscoverResult`](../interfaces/DiscoverResult.md)\>
▸ **discover**(`params`): `Promise`<[`DiscoverResult`](../interfaces/DiscoverResult.md)\>
#### Parameters
@ -52,13 +104,63 @@
#### Defined in
[lib/discovery/DiscoveryAPI.ts:142](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/discovery/DiscoveryAPI.ts#L142)
[lib/discovery/DiscoveryAPI.ts:149](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/discovery/DiscoveryAPI.ts#L149)
___
### fetch
▸ `Protected` **fetch**(`url`, `jsonResponse`, `method?`, `payload?`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse` | ``true`` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`any`\>
#### Inherited from
[DiscoveryAPI](DiscoveryAPI.md).[fetch](DiscoveryAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L19)
▸ `Protected` **fetch**(`url`, `jsonResponse?`, `method?`, `payload?`): `Promise`<`string`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse?` | `boolean` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`string`\>
#### Inherited from
[DiscoveryAPI](DiscoveryAPI.md).[fetch](DiscoveryAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L20)
___
### getAvailableOptions
▸ `Static` **getAvailableOptions**(): `Promise`<[`DiscoverOptions`](../interfaces/DiscoverOptions.md)\>
▸ **getAvailableOptions**(): `Promise`<[`DiscoverOptions`](../interfaces/DiscoverOptions.md)\>
#### Returns
@ -70,13 +172,13 @@ ___
#### Defined in
[lib/discovery/DiscoveryAPI.ts:134](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/discovery/DiscoveryAPI.ts#L134)
[lib/discovery/DiscoveryAPI.ts:141](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/discovery/DiscoveryAPI.ts#L141)
___
### sanitizeDiscoverParams
▸ `Static` **sanitizeDiscoverParams**(`params`): `Promise`<[`DiscoverParams`](../interfaces/DiscoverParams.md)\>
▸ **sanitizeDiscoverParams**(`params`): `Promise`<[`DiscoverParams`](../interfaces/DiscoverParams.md)\>
#### Parameters
@ -94,4 +196,4 @@ ___
#### Defined in
[lib/discovery/DiscoveryAPI.ts:138](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/discovery/DiscoveryAPI.ts#L138)
[lib/discovery/DiscoveryAPI.ts:145](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/discovery/DiscoveryAPI.ts#L145)

126
docs/api/classes/LimiterFanAPI.md
View File

@ -14,8 +14,14 @@
- [constructor](LimiterFanAPI.md#constructor)
### Accessors
- [cache](LimiterFanAPI.md#cache)
- [imageAPI](LimiterFanAPI.md#imageapi)
### Methods
- [fetch](LimiterFanAPI.md#fetch)
- [getCollection](LimiterFanAPI.md#getcollection)
- [getFollowingArtistsAndLabels](LimiterFanAPI.md#getfollowingartistsandlabels)
- [getFollowingGenres](LimiterFanAPI.md#getfollowinggenres)
@ -26,17 +32,113 @@
### constructor
• **new LimiterFanAPI**()
• **new LimiterFanAPI**(`params`)
#### Inherited from
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`BaseAPIWithImageSupportParams`](../interfaces/BaseAPIWithImageSupportParams.md) & { `limiter`: [`Limiter`](Limiter.md) } |
#### Overrides
[FanAPI](FanAPI.md).[constructor](FanAPI.md#constructor)
#### Defined in
[lib/fan/FanAPI.ts:143](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/fan/FanAPI.ts#L143)
## Accessors
### cache
• `Protected` `get` **cache**(): [`Cache`](Cache.md)
#### Returns
[`Cache`](Cache.md)
#### Inherited from
FanAPI.cache
#### Defined in
[lib/common/BaseAPI.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L25)
___
### imageAPI
• `get` **imageAPI**(): [`ImageAPI`](ImageAPI.md)
#### Returns
[`ImageAPI`](ImageAPI.md)
#### Inherited from
FanAPI.imageAPI
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L17)
## Methods
### fetch
▸ `Protected` **fetch**(`url`, `jsonResponse`, `method?`, `payload?`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse` | ``true`` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`any`\>
#### Inherited from
[FanAPI](FanAPI.md).[fetch](FanAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L19)
▸ `Protected` **fetch**(`url`, `jsonResponse?`, `method?`, `payload?`): `Promise`<`string`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse?` | `boolean` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`string`\>
#### Inherited from
[FanAPI](FanAPI.md).[fetch](FanAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L20)
___
### getCollection
▸ `Static` **getCollection**(`params`): `Promise`<[`FanPageItemsResult`](../interfaces/FanPageItemsResult.md)<`NonNullable`<``null`` \| [`Track`](../interfaces/Track.md) \| [`Album`](../interfaces/Album.md)\>\> \| [`FanContinuationItemsResult`](../interfaces/FanContinuationItemsResult.md)<`NonNullable`<``null`` \| [`Track`](../interfaces/Track.md) \| [`Album`](../interfaces/Album.md)\>\>\>
▸ **getCollection**(`params`): `Promise`<[`FanPageItemsResult`](../interfaces/FanPageItemsResult.md)<`NonNullable`<``null`` \| [`Track`](../interfaces/Track.md) \| [`Album`](../interfaces/Album.md)\>\> \| [`FanContinuationItemsResult`](../interfaces/FanContinuationItemsResult.md)<`NonNullable`<``null`` \| [`Track`](../interfaces/Track.md) \| [`Album`](../interfaces/Album.md)\>\>\>
#### Parameters
@ -54,13 +156,13 @@
#### Defined in
[lib/fan/FanAPI.ts:145](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/fan/FanAPI.ts#L145)
[lib/fan/FanAPI.ts:152](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/fan/FanAPI.ts#L152)
___
### getFollowingArtistsAndLabels
▸ `Static` **getFollowingArtistsAndLabels**(`params`): `Promise`<[`FanPageItemsResult`](../interfaces/FanPageItemsResult.md)<[`UserKind`](../interfaces/UserKind.md)\> \| [`FanContinuationItemsResult`](../interfaces/FanContinuationItemsResult.md)<[`UserKind`](../interfaces/UserKind.md)\>\>
▸ **getFollowingArtistsAndLabels**(`params`): `Promise`<[`FanPageItemsResult`](../interfaces/FanPageItemsResult.md)<[`UserKind`](../interfaces/UserKind.md)\> \| [`FanContinuationItemsResult`](../interfaces/FanContinuationItemsResult.md)<[`UserKind`](../interfaces/UserKind.md)\>\>
#### Parameters
@ -78,13 +180,13 @@ ___
#### Defined in
[lib/fan/FanAPI.ts:153](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/fan/FanAPI.ts#L153)
[lib/fan/FanAPI.ts:160](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/fan/FanAPI.ts#L160)
___
### getFollowingGenres
▸ `Static` **getFollowingGenres**(`params`): `Promise`<[`FanPageItemsResult`](../interfaces/FanPageItemsResult.md)<[`Tag`](../interfaces/Tag.md)\> \| [`FanContinuationItemsResult`](../interfaces/FanContinuationItemsResult.md)<[`Tag`](../interfaces/Tag.md)\>\>
▸ **getFollowingGenres**(`params`): `Promise`<[`FanPageItemsResult`](../interfaces/FanPageItemsResult.md)<[`Tag`](../interfaces/Tag.md)\> \| [`FanContinuationItemsResult`](../interfaces/FanContinuationItemsResult.md)<[`Tag`](../interfaces/Tag.md)\>\>
#### Parameters
@ -102,13 +204,13 @@ ___
#### Defined in
[lib/fan/FanAPI.ts:157](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/fan/FanAPI.ts#L157)
[lib/fan/FanAPI.ts:164](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/fan/FanAPI.ts#L164)
___
### getInfo
▸ `Static` **getInfo**(`params`): `Promise`<[`Fan`](../interfaces/Fan.md)\>
▸ **getInfo**(`params`): `Promise`<[`Fan`](../interfaces/Fan.md)\>
#### Parameters
@ -126,13 +228,13 @@ ___
#### Defined in
[lib/fan/FanAPI.ts:141](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/fan/FanAPI.ts#L141)
[lib/fan/FanAPI.ts:148](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/fan/FanAPI.ts#L148)
___
### getWishlist
▸ `Static` **getWishlist**(`params`): `Promise`<[`FanPageItemsResult`](../interfaces/FanPageItemsResult.md)<`NonNullable`<``null`` \| [`Track`](../interfaces/Track.md) \| [`Album`](../interfaces/Album.md)\>\> \| [`FanContinuationItemsResult`](../interfaces/FanContinuationItemsResult.md)<`NonNullable`<``null`` \| [`Track`](../interfaces/Track.md) \| [`Album`](../interfaces/Album.md)\>\>\>
▸ **getWishlist**(`params`): `Promise`<[`FanPageItemsResult`](../interfaces/FanPageItemsResult.md)<`NonNullable`<``null`` \| [`Track`](../interfaces/Track.md) \| [`Album`](../interfaces/Album.md)\>\> \| [`FanContinuationItemsResult`](../interfaces/FanContinuationItemsResult.md)<`NonNullable`<``null`` \| [`Track`](../interfaces/Track.md) \| [`Album`](../interfaces/Album.md)\>\>\>
#### Parameters
@ -150,4 +252,4 @@ ___
#### Defined in
[lib/fan/FanAPI.ts:149](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/fan/FanAPI.ts#L149)
[lib/fan/FanAPI.ts:156](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/fan/FanAPI.ts#L156)

95
docs/api/classes/LimiterImageAPI.md
View File

@ -14,8 +14,13 @@
- [constructor](LimiterImageAPI.md#constructor)
### Accessors
- [cache](LimiterImageAPI.md#cache)
### Methods
- [fetch](LimiterImageAPI.md#fetch)
- [getFormat](LimiterImageAPI.md#getformat)
- [getFormats](LimiterImageAPI.md#getformats)
@ -23,17 +28,95 @@
### constructor
• **new LimiterImageAPI**()
• **new LimiterImageAPI**(`params`)
#### Inherited from
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`BaseAPIParams`](../interfaces/BaseAPIParams.md) & { `limiter`: [`Limiter`](Limiter.md) } |
#### Overrides
[ImageAPI](ImageAPI.md).[constructor](ImageAPI.md#constructor)
#### Defined in
[lib/image/ImageAPI.ts:64](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/image/ImageAPI.ts#L64)
## Accessors
### cache
• `Protected` `get` **cache**(): [`Cache`](Cache.md)
#### Returns
[`Cache`](Cache.md)
#### Inherited from
ImageAPI.cache
#### Defined in
[lib/common/BaseAPI.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L25)
## Methods
### fetch
▸ `Protected` **fetch**(`url`, `jsonResponse`, `method?`, `payload?`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse` | ``true`` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`any`\>
#### Inherited from
[ImageAPI](ImageAPI.md).[fetch](ImageAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L19)
▸ `Protected` **fetch**(`url`, `jsonResponse?`, `method?`, `payload?`): `Promise`<`string`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse?` | `boolean` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`string`\>
#### Inherited from
[ImageAPI](ImageAPI.md).[fetch](ImageAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L20)
___
### getFormat
▸ `Static` **getFormat**(`target?`, `fallbackId?`): `Promise`<``null`` \| [`ImageFormat`](../interfaces/ImageFormat.md)\>
▸ **getFormat**(`target?`, `fallbackId?`): `Promise`<``null`` \| [`ImageFormat`](../interfaces/ImageFormat.md)\>
#### Parameters
@ -52,13 +135,13 @@
#### Defined in
[lib/image/ImageAPI.ts:66](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/image/ImageAPI.ts#L66)
[lib/image/ImageAPI.ts:73](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/image/ImageAPI.ts#L73)
___
### getFormats
▸ `Static` **getFormats**(`filter?`): `Promise`<[`ImageFormat`](../interfaces/ImageFormat.md)[]\>
▸ **getFormats**(`filter?`): `Promise`<[`ImageFormat`](../interfaces/ImageFormat.md)[]\>
#### Parameters
@ -76,4 +159,4 @@ ___
#### Defined in
[lib/image/ImageAPI.ts:62](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/image/ImageAPI.ts#L62)
[lib/image/ImageAPI.ts:69](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/image/ImageAPI.ts#L69)

142
docs/api/classes/LimiterSearchAPI.md
View File

@ -14,12 +14,18 @@
- [constructor](LimiterSearchAPI.md#constructor)
### Accessors
- [cache](LimiterSearchAPI.md#cache)
- [imageAPI](LimiterSearchAPI.md#imageapi)
### Methods
- [albums](LimiterSearchAPI.md#albums)
- [all](LimiterSearchAPI.md#all)
- [artistsAndLabels](LimiterSearchAPI.md#artistsandlabels)
- [fans](LimiterSearchAPI.md#fans)
- [fetch](LimiterSearchAPI.md#fetch)
- [search](LimiterSearchAPI.md#search)
- [tracks](LimiterSearchAPI.md#tracks)
@ -27,17 +33,63 @@
### constructor
• **new LimiterSearchAPI**()
• **new LimiterSearchAPI**(`params`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`BaseAPIWithImageSupportParams`](../interfaces/BaseAPIWithImageSupportParams.md) & { `limiter`: [`Limiter`](Limiter.md) } |
#### Overrides
[SearchAPI](SearchAPI.md).[constructor](SearchAPI.md#constructor)
#### Defined in
[lib/search/SearchAPI.ts:94](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L94)
## Accessors
### cache
• `Protected` `get` **cache**(): [`Cache`](Cache.md)
#### Returns
[`Cache`](Cache.md)
#### Inherited from
[SearchAPI](SearchAPI.md).[constructor](SearchAPI.md#constructor)
SearchAPI.cache
#### Defined in
[lib/common/BaseAPI.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L25)
___
### imageAPI
• `get` **imageAPI**(): [`ImageAPI`](ImageAPI.md)
#### Returns
[`ImageAPI`](ImageAPI.md)
#### Inherited from
SearchAPI.imageAPI
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L17)
## Methods
### albums
▸ `Static` **albums**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultAlbum`](../interfaces/SearchResultAlbum.md)\>\>
▸ **albums**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultAlbum`](../interfaces/SearchResultAlbum.md)\>\>
#### Parameters
@ -55,13 +107,13 @@
#### Defined in
[lib/search/SearchAPI.ts:101](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/search/SearchAPI.ts#L101)
[lib/search/SearchAPI.ts:107](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L107)
___
### all
▸ `Static` **all**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultAny`](../README.md#searchresultany)\>\>
▸ **all**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultAny`](../README.md#searchresultany)\>\>
#### Parameters
@ -79,13 +131,13 @@ ___
#### Defined in
[lib/search/SearchAPI.ts:93](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/search/SearchAPI.ts#L93)
[lib/search/SearchAPI.ts:99](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L99)
___
### artistsAndLabels
▸ `Static` **artistsAndLabels**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultArtist`](../interfaces/SearchResultArtist.md) \| [`SearchResultLabel`](../interfaces/SearchResultLabel.md)\>\>
▸ **artistsAndLabels**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultArtist`](../interfaces/SearchResultArtist.md) \| [`SearchResultLabel`](../interfaces/SearchResultLabel.md)\>\>
#### Parameters
@ -103,13 +155,13 @@ ___
#### Defined in
[lib/search/SearchAPI.ts:97](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/search/SearchAPI.ts#L97)
[lib/search/SearchAPI.ts:103](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L103)
___
### fans
▸ `Static` **fans**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultFan`](../interfaces/SearchResultFan.md)\>\>
▸ **fans**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultFan`](../interfaces/SearchResultFan.md)\>\>
#### Parameters
@ -127,13 +179,63 @@ ___
#### Defined in
[lib/search/SearchAPI.ts:109](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/search/SearchAPI.ts#L109)
[lib/search/SearchAPI.ts:115](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L115)
___
### fetch
▸ `Protected` **fetch**(`url`, `jsonResponse`, `method?`, `payload?`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse` | ``true`` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`any`\>
#### Inherited from
[SearchAPI](SearchAPI.md).[fetch](SearchAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L19)
▸ `Protected` **fetch**(`url`, `jsonResponse?`, `method?`, `payload?`): `Promise`<`string`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse?` | `boolean` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`string`\>
#### Inherited from
[SearchAPI](SearchAPI.md).[fetch](SearchAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L20)
___
### search
▸ `Static` `Protected` **search**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultAlbum`](../interfaces/SearchResultAlbum.md)\>\>
▸ `Protected` **search**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultAlbum`](../interfaces/SearchResultAlbum.md)\>\>
#### Parameters
@ -151,9 +253,9 @@ ___
#### Defined in
[lib/search/SearchAPI.ts:51](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/search/SearchAPI.ts#L51)
[lib/search/SearchAPI.ts:50](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L50)
▸ `Static` `Protected` **search**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultTrack`](../interfaces/SearchResultTrack.md)\>\>
▸ `Protected` **search**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultTrack`](../interfaces/SearchResultTrack.md)\>\>
#### Parameters
@ -171,9 +273,9 @@ ___
#### Defined in
[lib/search/SearchAPI.ts:52](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/search/SearchAPI.ts#L52)
[lib/search/SearchAPI.ts:51](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L51)
▸ `Static` `Protected` **search**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultFan`](../interfaces/SearchResultFan.md)\>\>
▸ `Protected` **search**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultFan`](../interfaces/SearchResultFan.md)\>\>
#### Parameters
@ -191,9 +293,9 @@ ___
#### Defined in
[lib/search/SearchAPI.ts:53](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/search/SearchAPI.ts#L53)
[lib/search/SearchAPI.ts:52](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L52)
▸ `Static` `Protected` **search**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultAny`](../README.md#searchresultany)\>\>
▸ `Protected` **search**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultAny`](../README.md#searchresultany)\>\>
#### Parameters
@ -211,13 +313,13 @@ ___
#### Defined in
[lib/search/SearchAPI.ts:54](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/search/SearchAPI.ts#L54)
[lib/search/SearchAPI.ts:53](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L53)
___
### tracks
▸ `Static` **tracks**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultTrack`](../interfaces/SearchResultTrack.md)\>\>
▸ **tracks**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultTrack`](../interfaces/SearchResultTrack.md)\>\>
#### Parameters
@ -235,4 +337,4 @@ ___
#### Defined in
[lib/search/SearchAPI.ts:105](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/search/SearchAPI.ts#L105)
[lib/search/SearchAPI.ts:111](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L111)

114
docs/api/classes/LimiterShowAPI.md
View File

@ -14,8 +14,14 @@
- [constructor](LimiterShowAPI.md#constructor)
### Accessors
- [cache](LimiterShowAPI.md#cache)
- [imageAPI](LimiterShowAPI.md#imageapi)
### Methods
- [fetch](LimiterShowAPI.md#fetch)
- [getShow](LimiterShowAPI.md#getshow)
- [list](LimiterShowAPI.md#list)
@ -23,17 +29,113 @@
### constructor
• **new LimiterShowAPI**()
• **new LimiterShowAPI**(`params`)
#### Inherited from
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`BaseAPIWithImageSupportParams`](../interfaces/BaseAPIWithImageSupportParams.md) & { `limiter`: [`Limiter`](Limiter.md) } |
#### Overrides
[ShowAPI](ShowAPI.md).[constructor](ShowAPI.md#constructor)
#### Defined in
[lib/show/ShowAPI.ts:50](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/show/ShowAPI.ts#L50)
## Accessors
### cache
• `Protected` `get` **cache**(): [`Cache`](Cache.md)
#### Returns
[`Cache`](Cache.md)
#### Inherited from
ShowAPI.cache
#### Defined in
[lib/common/BaseAPI.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L25)
___
### imageAPI
• `get` **imageAPI**(): [`ImageAPI`](ImageAPI.md)
#### Returns
[`ImageAPI`](ImageAPI.md)
#### Inherited from
ShowAPI.imageAPI
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L17)
## Methods
### fetch
▸ `Protected` **fetch**(`url`, `jsonResponse`, `method?`, `payload?`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse` | ``true`` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`any`\>
#### Inherited from
[ShowAPI](ShowAPI.md).[fetch](ShowAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L19)
▸ `Protected` **fetch**(`url`, `jsonResponse?`, `method?`, `payload?`): `Promise`<`string`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse?` | `boolean` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`string`\>
#### Inherited from
[ShowAPI](ShowAPI.md).[fetch](ShowAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L20)
___
### getShow
▸ `Static` **getShow**(`params`): `Promise`<[`Show`](../interfaces/Show.md)\>
▸ **getShow**(`params`): `Promise`<[`Show`](../interfaces/Show.md)\>
#### Parameters
@ -51,13 +153,13 @@
#### Defined in
[lib/show/ShowAPI.ts:49](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/show/ShowAPI.ts#L49)
[lib/show/ShowAPI.ts:55](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/show/ShowAPI.ts#L55)
___
### list
▸ `Static` **list**(`params?`): `Promise`<[`Show`](../interfaces/Show.md)[]\>
▸ **list**(`params?`): `Promise`<[`Show`](../interfaces/Show.md)[]\>
#### Parameters
@ -75,4 +177,4 @@ ___
#### Defined in
[lib/show/ShowAPI.ts:53](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/show/ShowAPI.ts#L53)
[lib/show/ShowAPI.ts:59](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/show/ShowAPI.ts#L59)

126
docs/api/classes/LimiterTagAPI.md
View File

@ -14,8 +14,14 @@
- [constructor](LimiterTagAPI.md#constructor)
### Accessors
- [cache](LimiterTagAPI.md#cache)
- [imageAPI](LimiterTagAPI.md#imageapi)
### Methods
- [fetch](LimiterTagAPI.md#fetch)
- [getAlbumHighlights](LimiterTagAPI.md#getalbumhighlights)
- [getInfo](LimiterTagAPI.md#getinfo)
- [getReleases](LimiterTagAPI.md#getreleases)
@ -26,17 +32,113 @@
### constructor
• **new LimiterTagAPI**()
• **new LimiterTagAPI**(`params`)
#### Inherited from
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`BaseAPIWithImageSupportParams`](../interfaces/BaseAPIWithImageSupportParams.md) & { `limiter`: [`Limiter`](Limiter.md) } |
#### Overrides
[TagAPI](TagAPI.md).[constructor](TagAPI.md#constructor)
#### Defined in
[lib/tag/TagAPI.ts:148](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/tag/TagAPI.ts#L148)
## Accessors
### cache
• `Protected` `get` **cache**(): [`Cache`](Cache.md)
#### Returns
[`Cache`](Cache.md)
#### Inherited from
TagAPI.cache
#### Defined in
[lib/common/BaseAPI.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L25)
___
### imageAPI
• `get` **imageAPI**(): [`ImageAPI`](ImageAPI.md)
#### Returns
[`ImageAPI`](ImageAPI.md)
#### Inherited from
TagAPI.imageAPI
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L17)
## Methods
### fetch
▸ `Protected` **fetch**(`url`, `jsonResponse`, `method?`, `payload?`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse` | ``true`` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`any`\>
#### Inherited from
[TagAPI](TagAPI.md).[fetch](TagAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L19)
▸ `Protected` **fetch**(`url`, `jsonResponse?`, `method?`, `payload?`): `Promise`<`string`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse?` | `boolean` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`string`\>
#### Inherited from
[TagAPI](TagAPI.md).[fetch](TagAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L20)
___
### getAlbumHighlights
▸ `Static` **getAlbumHighlights**(`params`): `Promise`<[`AlbumHighlightsByTag`](../interfaces/AlbumHighlightsByTag.md)[]\>
▸ **getAlbumHighlights**(`params`): `Promise`<[`AlbumHighlightsByTag`](../interfaces/AlbumHighlightsByTag.md)[]\>
#### Parameters
@ -54,13 +156,13 @@
#### Defined in
[lib/tag/TagAPI.ts:154](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/tag/TagAPI.ts#L154)
[lib/tag/TagAPI.ts:161](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/tag/TagAPI.ts#L161)
___
### getInfo
▸ `Static` **getInfo**(`tagUrl`): `Promise`<[`Tag`](../interfaces/Tag.md)\>
▸ **getInfo**(`tagUrl`): `Promise`<[`Tag`](../interfaces/Tag.md)\>
#### Parameters
@ -78,13 +180,13 @@ ___
#### Defined in
[lib/tag/TagAPI.ts:150](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/tag/TagAPI.ts#L150)
[lib/tag/TagAPI.ts:157](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/tag/TagAPI.ts#L157)
___
### getReleases
▸ `Static` **getReleases**(`params`): `Promise`<[`ReleasesByTag`](../interfaces/ReleasesByTag-1.md)\>
▸ **getReleases**(`params`): `Promise`<[`ReleasesByTag`](../interfaces/ReleasesByTag-1.md)\>
#### Parameters
@ -102,13 +204,13 @@ ___
#### Defined in
[lib/tag/TagAPI.ts:162](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/tag/TagAPI.ts#L162)
[lib/tag/TagAPI.ts:169](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/tag/TagAPI.ts#L169)
___
### getReleasesAvailableFilters
▸ `Static` **getReleasesAvailableFilters**(`tagUrl`): `Promise`<[`Filter`](../interfaces/ReleasesByTag.Filter.md)[]\>
▸ **getReleasesAvailableFilters**(`tagUrl`): `Promise`<[`Filter`](../interfaces/ReleasesByTag.Filter.md)[]\>
#### Parameters
@ -126,13 +228,13 @@ ___
#### Defined in
[lib/tag/TagAPI.ts:158](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/tag/TagAPI.ts#L158)
[lib/tag/TagAPI.ts:165](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/tag/TagAPI.ts#L165)
___
### list
▸ `Static` **list**(): `Promise`<[`TagList`](../interfaces/TagList.md)\>
▸ **list**(): `Promise`<[`TagList`](../interfaces/TagList.md)\>
#### Returns
@ -144,4 +246,4 @@ ___
#### Defined in
[lib/tag/TagAPI.ts:146](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/tag/TagAPI.ts#L146)
[lib/tag/TagAPI.ts:153](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/tag/TagAPI.ts#L153)

110
docs/api/classes/LimiterTrackAPI.md
View File

@ -14,25 +14,127 @@
- [constructor](LimiterTrackAPI.md#constructor)
### Accessors
- [cache](LimiterTrackAPI.md#cache)
- [imageAPI](LimiterTrackAPI.md#imageapi)
### Methods
- [fetch](LimiterTrackAPI.md#fetch)
- [getInfo](LimiterTrackAPI.md#getinfo)
## Constructors
### constructor
• **new LimiterTrackAPI**()
• **new LimiterTrackAPI**(`params`)
#### Inherited from
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`BaseAPIWithImageSupportParams`](../interfaces/BaseAPIWithImageSupportParams.md) & { `limiter`: [`Limiter`](Limiter.md) } |
#### Overrides
[TrackAPI](TrackAPI.md).[constructor](TrackAPI.md#constructor)
#### Defined in
[lib/track/TrackAPI.ts:33](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/track/TrackAPI.ts#L33)
## Accessors
### cache
• `Protected` `get` **cache**(): [`Cache`](Cache.md)
#### Returns
[`Cache`](Cache.md)
#### Inherited from
TrackAPI.cache
#### Defined in
[lib/common/BaseAPI.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L25)
___
### imageAPI
• `get` **imageAPI**(): [`ImageAPI`](ImageAPI.md)
#### Returns
[`ImageAPI`](ImageAPI.md)
#### Inherited from
TrackAPI.imageAPI
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L17)
## Methods
### fetch
▸ `Protected` **fetch**(`url`, `jsonResponse`, `method?`, `payload?`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse` | ``true`` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`any`\>
#### Inherited from
[TrackAPI](TrackAPI.md).[fetch](TrackAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L19)
▸ `Protected` **fetch**(`url`, `jsonResponse?`, `method?`, `payload?`): `Promise`<`string`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse?` | `boolean` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`string`\>
#### Inherited from
[TrackAPI](TrackAPI.md).[fetch](TrackAPI.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L20)
___
### getInfo
▸ `Static` **getInfo**(`params`): `Promise`<[`Track`](../interfaces/Track.md)\>
▸ **getInfo**(`params`): `Promise`<[`Track`](../interfaces/Track.md)\>
#### Parameters
@ -50,4 +152,4 @@
#### Defined in
[lib/track/TrackAPI.ts:31](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/track/TrackAPI.ts#L31)
[lib/track/TrackAPI.ts:37](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/track/TrackAPI.ts#L37)

150
docs/api/classes/SearchAPI.md
View File

@ -4,9 +4,11 @@
## Hierarchy
- **`SearchAPI`**
- [`BaseAPIWithImageSupport`](BaseAPIWithImageSupport.md)
↳ [`LimiterSearchAPI`](LimiterSearchAPI.md)
↳ **`SearchAPI`**
↳↳ [`LimiterSearchAPI`](LimiterSearchAPI.md)
## Table of contents
@ -14,12 +16,18 @@
- [constructor](SearchAPI.md#constructor)
### Accessors
- [cache](SearchAPI.md#cache)
- [imageAPI](SearchAPI.md#imageapi)
### Methods
- [albums](SearchAPI.md#albums)
- [all](SearchAPI.md#all)
- [artistsAndLabels](SearchAPI.md#artistsandlabels)
- [fans](SearchAPI.md#fans)
- [fetch](SearchAPI.md#fetch)
- [search](SearchAPI.md#search)
- [tracks](SearchAPI.md#tracks)
@ -27,13 +35,63 @@
### constructor
• **new SearchAPI**()
• **new SearchAPI**(`params`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`BaseAPIWithImageSupportParams`](../interfaces/BaseAPIWithImageSupportParams.md) |
#### Inherited from
[BaseAPIWithImageSupport](BaseAPIWithImageSupport.md).[constructor](BaseAPIWithImageSupport.md#constructor)
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L12)
## Accessors
### cache
• `Protected` `get` **cache**(): [`Cache`](Cache.md)
#### Returns
[`Cache`](Cache.md)
#### Inherited from
BaseAPIWithImageSupport.cache
#### Defined in
[lib/common/BaseAPI.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L25)
___
### imageAPI
• `get` **imageAPI**(): [`ImageAPI`](ImageAPI.md)
#### Returns
[`ImageAPI`](ImageAPI.md)
#### Inherited from
BaseAPIWithImageSupport.imageAPI
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L17)
## Methods
### albums
▸ `Static` **albums**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultAlbum`](../interfaces/SearchResultAlbum.md)\>\>
▸ **albums**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultAlbum`](../interfaces/SearchResultAlbum.md)\>\>
#### Parameters
@ -47,13 +105,13 @@
#### Defined in
[lib/search/SearchAPI.ts:35](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/search/SearchAPI.ts#L35)
[lib/search/SearchAPI.ts:34](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L34)
___
### all
▸ `Static` **all**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultAny`](../README.md#searchresultany)\>\>
▸ **all**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultAny`](../README.md#searchresultany)\>\>
#### Parameters
@ -67,13 +125,13 @@ ___
#### Defined in
[lib/search/SearchAPI.ts:27](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/search/SearchAPI.ts#L27)
[lib/search/SearchAPI.ts:26](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L26)
___
### artistsAndLabels
▸ `Static` **artistsAndLabels**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultArtist`](../interfaces/SearchResultArtist.md) \| [`SearchResultLabel`](../interfaces/SearchResultLabel.md)\>\>
▸ **artistsAndLabels**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultArtist`](../interfaces/SearchResultArtist.md) \| [`SearchResultLabel`](../interfaces/SearchResultLabel.md)\>\>
#### Parameters
@ -87,13 +145,13 @@ ___
#### Defined in
[lib/search/SearchAPI.ts:31](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/search/SearchAPI.ts#L31)
[lib/search/SearchAPI.ts:30](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L30)
___
### fans
▸ `Static` **fans**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultFan`](../interfaces/SearchResultFan.md)\>\>
▸ **fans**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultFan`](../interfaces/SearchResultFan.md)\>\>
#### Parameters
@ -107,13 +165,63 @@ ___
#### Defined in
[lib/search/SearchAPI.ts:43](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/search/SearchAPI.ts#L43)
[lib/search/SearchAPI.ts:42](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L42)
___
### fetch
▸ `Protected` **fetch**(`url`, `jsonResponse`, `method?`, `payload?`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse` | ``true`` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`any`\>
#### Inherited from
[BaseAPIWithImageSupport](BaseAPIWithImageSupport.md).[fetch](BaseAPIWithImageSupport.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L19)
▸ `Protected` **fetch**(`url`, `jsonResponse?`, `method?`, `payload?`): `Promise`<`string`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse?` | `boolean` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`string`\>
#### Inherited from
[BaseAPIWithImageSupport](BaseAPIWithImageSupport.md).[fetch](BaseAPIWithImageSupport.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L20)
___
### search
▸ `Static` `Protected` **search**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultAlbum`](../interfaces/SearchResultAlbum.md)\>\>
▸ `Protected` **search**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultAlbum`](../interfaces/SearchResultAlbum.md)\>\>
#### Parameters
@ -127,9 +235,9 @@ ___
#### Defined in
[lib/search/SearchAPI.ts:51](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/search/SearchAPI.ts#L51)
[lib/search/SearchAPI.ts:50](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L50)
▸ `Static` `Protected` **search**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultTrack`](../interfaces/SearchResultTrack.md)\>\>
▸ `Protected` **search**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultTrack`](../interfaces/SearchResultTrack.md)\>\>
#### Parameters
@ -143,9 +251,9 @@ ___
#### Defined in
[lib/search/SearchAPI.ts:52](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/search/SearchAPI.ts#L52)
[lib/search/SearchAPI.ts:51](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L51)
▸ `Static` `Protected` **search**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultFan`](../interfaces/SearchResultFan.md)\>\>
▸ `Protected` **search**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultFan`](../interfaces/SearchResultFan.md)\>\>
#### Parameters
@ -159,9 +267,9 @@ ___
#### Defined in
[lib/search/SearchAPI.ts:53](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/search/SearchAPI.ts#L53)
[lib/search/SearchAPI.ts:52](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L52)
▸ `Static` `Protected` **search**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultAny`](../README.md#searchresultany)\>\>
▸ `Protected` **search**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultAny`](../README.md#searchresultany)\>\>
#### Parameters
@ -175,13 +283,13 @@ ___
#### Defined in
[lib/search/SearchAPI.ts:54](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/search/SearchAPI.ts#L54)
[lib/search/SearchAPI.ts:53](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L53)
___
### tracks
▸ `Static` **tracks**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultTrack`](../interfaces/SearchResultTrack.md)\>\>
▸ **tracks**(`params`): `Promise`<[`SearchResults`](../interfaces/SearchResults.md)<[`SearchResultTrack`](../interfaces/SearchResultTrack.md)\>\>
#### Parameters
@ -195,4 +303,4 @@ ___
#### Defined in
[lib/search/SearchAPI.ts:39](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/search/SearchAPI.ts#L39)
[lib/search/SearchAPI.ts:38](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L38)

122
docs/api/classes/ShowAPI.md
View File

@ -4,9 +4,11 @@
## Hierarchy
- **`ShowAPI`**
- [`BaseAPIWithImageSupport`](BaseAPIWithImageSupport.md)
↳ [`LimiterShowAPI`](LimiterShowAPI.md)
↳ **`ShowAPI`**
↳↳ [`LimiterShowAPI`](LimiterShowAPI.md)
## Table of contents
@ -14,8 +16,14 @@
- [constructor](ShowAPI.md#constructor)
### Accessors
- [cache](ShowAPI.md#cache)
- [imageAPI](ShowAPI.md#imageapi)
### Methods
- [fetch](ShowAPI.md#fetch)
- [getShow](ShowAPI.md#getshow)
- [list](ShowAPI.md#list)
@ -23,13 +31,113 @@
### constructor
• **new ShowAPI**()
• **new ShowAPI**(`params`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`BaseAPIWithImageSupportParams`](../interfaces/BaseAPIWithImageSupportParams.md) |
#### Inherited from
[BaseAPIWithImageSupport](BaseAPIWithImageSupport.md).[constructor](BaseAPIWithImageSupport.md#constructor)
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L12)
## Accessors
### cache
• `Protected` `get` **cache**(): [`Cache`](Cache.md)
#### Returns
[`Cache`](Cache.md)
#### Inherited from
BaseAPIWithImageSupport.cache
#### Defined in
[lib/common/BaseAPI.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L25)
___
### imageAPI
• `get` **imageAPI**(): [`ImageAPI`](ImageAPI.md)
#### Returns
[`ImageAPI`](ImageAPI.md)
#### Inherited from
BaseAPIWithImageSupport.imageAPI
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L17)
## Methods
### fetch
▸ `Protected` **fetch**(`url`, `jsonResponse`, `method?`, `payload?`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse` | ``true`` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`any`\>
#### Inherited from
[BaseAPIWithImageSupport](BaseAPIWithImageSupport.md).[fetch](BaseAPIWithImageSupport.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L19)
▸ `Protected` **fetch**(`url`, `jsonResponse?`, `method?`, `payload?`): `Promise`<`string`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse?` | `boolean` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`string`\>
#### Inherited from
[BaseAPIWithImageSupport](BaseAPIWithImageSupport.md).[fetch](BaseAPIWithImageSupport.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L20)
___
### getShow
▸ `Static` **getShow**(`params`): `Promise`<[`Show`](../interfaces/Show.md)\>
▸ **getShow**(`params`): `Promise`<[`Show`](../interfaces/Show.md)\>
#### Parameters
@ -43,13 +151,13 @@
#### Defined in
[lib/show/ShowAPI.ts:23](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/show/ShowAPI.ts#L23)
[lib/show/ShowAPI.ts:22](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/show/ShowAPI.ts#L22)
___
### list
▸ `Static` **list**(`params?`): `Promise`<[`Show`](../interfaces/Show.md)[]\>
▸ **list**(`params?`): `Promise`<[`Show`](../interfaces/Show.md)[]\>
#### Parameters
@ -63,4 +171,4 @@ ___
#### Defined in
[lib/show/ShowAPI.ts:36](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/show/ShowAPI.ts#L36)
[lib/show/ShowAPI.ts:35](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/show/ShowAPI.ts#L35)

134
docs/api/classes/TagAPI.md
View File

@ -4,9 +4,11 @@
## Hierarchy
- **`TagAPI`**
- [`BaseAPIWithImageSupport`](BaseAPIWithImageSupport.md)
↳ [`LimiterTagAPI`](LimiterTagAPI.md)
↳ **`TagAPI`**
↳↳ [`LimiterTagAPI`](LimiterTagAPI.md)
## Table of contents
@ -14,8 +16,14 @@
- [constructor](TagAPI.md#constructor)
### Accessors
- [cache](TagAPI.md#cache)
- [imageAPI](TagAPI.md#imageapi)
### Methods
- [fetch](TagAPI.md#fetch)
- [getAlbumHighlights](TagAPI.md#getalbumhighlights)
- [getInfo](TagAPI.md#getinfo)
- [getReleases](TagAPI.md#getreleases)
@ -26,13 +34,113 @@
### constructor
• **new TagAPI**()
• **new TagAPI**(`params`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`BaseAPIWithImageSupportParams`](../interfaces/BaseAPIWithImageSupportParams.md) |
#### Inherited from
[BaseAPIWithImageSupport](BaseAPIWithImageSupport.md).[constructor](BaseAPIWithImageSupport.md#constructor)
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L12)
## Accessors
### cache
• `Protected` `get` **cache**(): [`Cache`](Cache.md)
#### Returns
[`Cache`](Cache.md)
#### Inherited from
BaseAPIWithImageSupport.cache
#### Defined in
[lib/common/BaseAPI.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L25)
___
### imageAPI
• `get` **imageAPI**(): [`ImageAPI`](ImageAPI.md)
#### Returns
[`ImageAPI`](ImageAPI.md)
#### Inherited from
BaseAPIWithImageSupport.imageAPI
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L17)
## Methods
### fetch
▸ `Protected` **fetch**(`url`, `jsonResponse`, `method?`, `payload?`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse` | ``true`` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`any`\>
#### Inherited from
[BaseAPIWithImageSupport](BaseAPIWithImageSupport.md).[fetch](BaseAPIWithImageSupport.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L19)
▸ `Protected` **fetch**(`url`, `jsonResponse?`, `method?`, `payload?`): `Promise`<`string`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse?` | `boolean` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`string`\>
#### Inherited from
[BaseAPIWithImageSupport](BaseAPIWithImageSupport.md).[fetch](BaseAPIWithImageSupport.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L20)
___
### getAlbumHighlights
▸ `Static` **getAlbumHighlights**(`params`): `Promise`<[`AlbumHighlightsByTag`](../interfaces/AlbumHighlightsByTag.md)[]\>
▸ **getAlbumHighlights**(`params`): `Promise`<[`AlbumHighlightsByTag`](../interfaces/AlbumHighlightsByTag.md)[]\>
#### Parameters
@ -46,13 +154,13 @@
#### Defined in
[lib/tag/TagAPI.ts:38](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/tag/TagAPI.ts#L38)
[lib/tag/TagAPI.ts:38](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/tag/TagAPI.ts#L38)
___
### getInfo
▸ `Static` **getInfo**(`tagUrl`): `Promise`<[`Tag`](../interfaces/Tag.md)\>
▸ **getInfo**(`tagUrl`): `Promise`<[`Tag`](../interfaces/Tag.md)\>
#### Parameters
@ -66,13 +174,13 @@ ___
#### Defined in
[lib/tag/TagAPI.ts:33](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/tag/TagAPI.ts#L33)
[lib/tag/TagAPI.ts:33](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/tag/TagAPI.ts#L33)
___
### getReleases
▸ `Static` **getReleases**(`params`): `Promise`<[`ReleasesByTag`](../interfaces/ReleasesByTag-1.md)\>
▸ **getReleases**(`params`): `Promise`<[`ReleasesByTag`](../interfaces/ReleasesByTag-1.md)\>
#### Parameters
@ -86,13 +194,13 @@ ___
#### Defined in
[lib/tag/TagAPI.ts:55](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/tag/TagAPI.ts#L55)
[lib/tag/TagAPI.ts:55](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/tag/TagAPI.ts#L55)
___
### getReleasesAvailableFilters
▸ `Static` **getReleasesAvailableFilters**(`tagUrl`): `Promise`<[`Filter`](../interfaces/ReleasesByTag.Filter.md)[]\>
▸ **getReleasesAvailableFilters**(`tagUrl`): `Promise`<[`Filter`](../interfaces/ReleasesByTag.Filter.md)[]\>
#### Parameters
@ -106,13 +214,13 @@ ___
#### Defined in
[lib/tag/TagAPI.ts:49](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/tag/TagAPI.ts#L49)
[lib/tag/TagAPI.ts:49](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/tag/TagAPI.ts#L49)
___
### list
▸ `Static` **list**(): `Promise`<[`TagList`](../interfaces/TagList.md)\>
▸ **list**(): `Promise`<[`TagList`](../interfaces/TagList.md)\>
#### Returns
@ -120,4 +228,4 @@ ___
#### Defined in
[lib/tag/TagAPI.ts:28](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/tag/TagAPI.ts#L28)
[lib/tag/TagAPI.ts:28](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/tag/TagAPI.ts#L28)

118
docs/api/classes/TrackAPI.md
View File

@ -4,9 +4,11 @@
## Hierarchy
- **`TrackAPI`**
- [`BaseAPIWithImageSupport`](BaseAPIWithImageSupport.md)
↳ [`LimiterTrackAPI`](LimiterTrackAPI.md)
↳ **`TrackAPI`**
↳↳ [`LimiterTrackAPI`](LimiterTrackAPI.md)
## Table of contents
@ -14,21 +16,127 @@
- [constructor](TrackAPI.md#constructor)
### Accessors
- [cache](TrackAPI.md#cache)
- [imageAPI](TrackAPI.md#imageapi)
### Methods
- [fetch](TrackAPI.md#fetch)
- [getInfo](TrackAPI.md#getinfo)
## Constructors
### constructor
• **new TrackAPI**()
• **new TrackAPI**(`params`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`BaseAPIWithImageSupportParams`](../interfaces/BaseAPIWithImageSupportParams.md) |
#### Inherited from
[BaseAPIWithImageSupport](BaseAPIWithImageSupport.md).[constructor](BaseAPIWithImageSupport.md#constructor)
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L12)
## Accessors
### cache
• `Protected` `get` **cache**(): [`Cache`](Cache.md)
#### Returns
[`Cache`](Cache.md)
#### Inherited from
BaseAPIWithImageSupport.cache
#### Defined in
[lib/common/BaseAPI.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L25)
___
### imageAPI
• `get` **imageAPI**(): [`ImageAPI`](ImageAPI.md)
#### Returns
[`ImageAPI`](ImageAPI.md)
#### Inherited from
BaseAPIWithImageSupport.imageAPI
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L17)
## Methods
### fetch
▸ `Protected` **fetch**(`url`, `jsonResponse`, `method?`, `payload?`): `Promise`<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse` | ``true`` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`any`\>
#### Inherited from
[BaseAPIWithImageSupport](BaseAPIWithImageSupport.md).[fetch](BaseAPIWithImageSupport.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L19)
▸ `Protected` **fetch**(`url`, `jsonResponse?`, `method?`, `payload?`): `Promise`<`string`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `jsonResponse?` | `boolean` |
| `method?` | [`FetchMethod`](../enums/FetchMethod.md) |
| `payload?` | `Record`<`string`, `any`\> |
#### Returns
`Promise`<`string`\>
#### Inherited from
[BaseAPIWithImageSupport](BaseAPIWithImageSupport.md).[fetch](BaseAPIWithImageSupport.md#fetch)
#### Defined in
[lib/common/BaseAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L20)
___
### getInfo
▸ `Static` **getInfo**(`params`): `Promise`<[`Track`](../interfaces/Track.md)\>
▸ **getInfo**(`params`): `Promise`<[`Track`](../interfaces/Track.md)\>
#### Parameters
@ -42,4 +150,4 @@
#### Defined in
[lib/track/TrackAPI.ts:16](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/track/TrackAPI.ts#L16)
[lib/track/TrackAPI.ts:15](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/track/TrackAPI.ts#L15)

4
docs/api/enums/AutocompleteItemType.md
View File

@ -17,7 +17,7 @@
#### Defined in
[lib/autocomplete/AutocompleteAPI.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/autocomplete/AutocompleteAPI.ts#L9)
[lib/autocomplete/AutocompleteAPI.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/autocomplete/AutocompleteAPI.ts#L10)
___
@ -27,4 +27,4 @@ ___
#### Defined in
[lib/autocomplete/AutocompleteAPI.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/autocomplete/AutocompleteAPI.ts#L8)
[lib/autocomplete/AutocompleteAPI.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/autocomplete/AutocompleteAPI.ts#L9)

4
docs/api/enums/CacheDataType.md
View File

@ -17,7 +17,7 @@
#### Defined in
[lib/utils/Cache.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/utils/Cache.ts#L5)
[lib/utils/Cache.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/Cache.ts#L5)
___
@ -27,4 +27,4 @@ ___
#### Defined in
[lib/utils/Cache.ts:4](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/utils/Cache.ts#L4)
[lib/utils/Cache.ts:4](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/Cache.ts#L4)

30
docs/api/enums/FetchMethod.md Normal file
View File

@ -0,0 +1,30 @@
[bandcamp-fetch](../README.md) / FetchMethod
# Enumeration: FetchMethod
## Table of contents
### Enumeration Members
- [GET](FetchMethod.md#get)
- [POST](FetchMethod.md#post)
## Enumeration Members
### GET
• **GET** = ``"GET"``
#### Defined in
[lib/utils/Fetcher.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/Fetcher.ts#L6)
___
### POST
• **POST** = ``"POST"``
#### Defined in
[lib/utils/Fetcher.ts:7](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/Fetcher.ts#L7)

4
docs/api/enums/ImageFormatFilter.md
View File

@ -19,7 +19,7 @@ Album image formats
#### Defined in
[lib/image/ImageAPI.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/image/ImageAPI.ts#L10)
[lib/image/ImageAPI.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/image/ImageAPI.ts#L10)
___
@ -31,4 +31,4 @@ Artist / Profile image formats
#### Defined in
[lib/image/ImageAPI.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/image/ImageAPI.ts#L12)
[lib/image/ImageAPI.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/image/ImageAPI.ts#L12)

10
docs/api/enums/SearchItemType.md
View File

@ -20,7 +20,7 @@
#### Defined in
[lib/search/SearchAPI.ts:13](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/search/SearchAPI.ts#L13)
[lib/search/SearchAPI.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L12)
___
@ -30,7 +30,7 @@ ___
#### Defined in
[lib/search/SearchAPI.ts:11](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/search/SearchAPI.ts#L11)
[lib/search/SearchAPI.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L10)
___
@ -40,7 +40,7 @@ ___
#### Defined in
[lib/search/SearchAPI.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/search/SearchAPI.ts#L12)
[lib/search/SearchAPI.ts:11](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L11)
___
@ -50,7 +50,7 @@ ___
#### Defined in
[lib/search/SearchAPI.ts:15](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/search/SearchAPI.ts#L15)
[lib/search/SearchAPI.ts:14](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L14)
___
@ -60,4 +60,4 @@ ___
#### Defined in
[lib/search/SearchAPI.ts:14](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/search/SearchAPI.ts#L14)
[lib/search/SearchAPI.ts:13](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L13)

34
docs/api/interfaces/Album.md
View File

@ -42,7 +42,7 @@
#### Defined in
[lib/types/MediaKind.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/MediaKind.ts#L10)
[lib/types/MediaKind.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/MediaKind.ts#L10)
___
@ -52,7 +52,7 @@ ___
#### Defined in
[lib/types/Album.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Album.ts#L8)
[lib/types/Album.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Album.ts#L8)
___
@ -62,7 +62,7 @@ ___
#### Defined in
[lib/types/Album.ts:11](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Album.ts#L11)
[lib/types/Album.ts:11](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Album.ts#L11)
___
@ -72,7 +72,7 @@ ___
#### Defined in
[lib/types/Album.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Album.ts#L9)
[lib/types/Album.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Album.ts#L9)
___
@ -86,7 +86,7 @@ ___
#### Defined in
[lib/types/MediaKind.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/MediaKind.ts#L8)
[lib/types/MediaKind.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/MediaKind.ts#L8)
___
@ -96,7 +96,7 @@ ___
#### Defined in
[lib/types/Album.ts:7](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Album.ts#L7)
[lib/types/Album.ts:7](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Album.ts#L7)
___
@ -110,7 +110,7 @@ ___
#### Defined in
[lib/types/MediaKind.ts:11](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/MediaKind.ts#L11)
[lib/types/MediaKind.ts:11](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/MediaKind.ts#L11)
___
@ -120,7 +120,7 @@ ___
#### Defined in
[lib/types/Album.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Album.ts#L10)
[lib/types/Album.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Album.ts#L10)
___
@ -134,7 +134,7 @@ ___
#### Defined in
[lib/types/MediaKind.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/MediaKind.ts#L6)
[lib/types/MediaKind.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/MediaKind.ts#L6)
___
@ -144,7 +144,7 @@ ___
#### Defined in
[lib/types/Album.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Album.ts#L6)
[lib/types/Album.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Album.ts#L6)
___
@ -158,7 +158,7 @@ ___
#### Defined in
[lib/types/MediaKind.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/MediaKind.ts#L12)
[lib/types/MediaKind.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/MediaKind.ts#L12)
___
@ -179,7 +179,7 @@ ___
#### Defined in
[lib/types/MediaKind.ts:13](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/MediaKind.ts#L13)
[lib/types/MediaKind.ts:13](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/MediaKind.ts#L13)
___
@ -193,7 +193,7 @@ ___
#### Defined in
[lib/types/MediaKind.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/MediaKind.ts#L9)
[lib/types/MediaKind.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/MediaKind.ts#L9)
___
@ -203,7 +203,7 @@ ___
#### Defined in
[lib/types/Album.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Album.ts#L12)
[lib/types/Album.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Album.ts#L12)
___
@ -213,7 +213,7 @@ ___
#### Defined in
[lib/types/Album.ts:13](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Album.ts#L13)
[lib/types/Album.ts:13](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Album.ts#L13)
___
@ -223,7 +223,7 @@ ___
#### Defined in
[lib/types/Album.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Album.ts#L5)
[lib/types/Album.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Album.ts#L5)
___
@ -237,4 +237,4 @@ ___
#### Defined in
[lib/types/MediaKind.ts:7](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/MediaKind.ts#L7)
[lib/types/MediaKind.ts:7](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/MediaKind.ts#L7)

8
docs/api/interfaces/AlbumAPIGetInfoParams.md
View File

@ -19,7 +19,7 @@
#### Defined in
[lib/album/AlbumAPI.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/album/AlbumAPI.ts#L10)
[lib/album/AlbumAPI.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/album/AlbumAPI.ts#L9)
___
@ -29,7 +29,7 @@ ___
#### Defined in
[lib/album/AlbumAPI.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/album/AlbumAPI.ts#L9)
[lib/album/AlbumAPI.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/album/AlbumAPI.ts#L8)
___
@ -39,7 +39,7 @@ ___
#### Defined in
[lib/album/AlbumAPI.ts:11](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/album/AlbumAPI.ts#L11)
[lib/album/AlbumAPI.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/album/AlbumAPI.ts#L10)
___
@ -49,4 +49,4 @@ ___
#### Defined in
[lib/album/AlbumAPI.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/album/AlbumAPI.ts#L12)
[lib/album/AlbumAPI.ts:11](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/album/AlbumAPI.ts#L11)

6
docs/api/interfaces/AlbumHighlightsByTag.md
View File

@ -18,7 +18,7 @@
#### Defined in
[lib/types/Tag.ts:23](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Tag.ts#L23)
[lib/types/Tag.ts:23](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Tag.ts#L23)
___
@ -28,7 +28,7 @@ ___
#### Defined in
[lib/types/Tag.ts:21](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Tag.ts#L21)
[lib/types/Tag.ts:21](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Tag.ts#L21)
___
@ -38,4 +38,4 @@ ___
#### Defined in
[lib/types/Tag.ts:22](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Tag.ts#L22)
[lib/types/Tag.ts:22](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Tag.ts#L22)

10
docs/api/interfaces/AlbumRelease.md
View File

@ -20,7 +20,7 @@
#### Defined in
[lib/types/Album.ts:21](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Album.ts#L21)
[lib/types/Album.ts:21](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Album.ts#L21)
___
@ -30,7 +30,7 @@ ___
#### Defined in
[lib/types/Album.ts:18](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Album.ts#L18)
[lib/types/Album.ts:18](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Album.ts#L18)
___
@ -40,7 +40,7 @@ ___
#### Defined in
[lib/types/Album.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Album.ts#L20)
[lib/types/Album.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Album.ts#L20)
___
@ -50,7 +50,7 @@ ___
#### Defined in
[lib/types/Album.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Album.ts#L17)
[lib/types/Album.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Album.ts#L17)
___
@ -60,4 +60,4 @@ ___
#### Defined in
[lib/types/Album.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Album.ts#L19)
[lib/types/Album.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Album.ts#L19)

22
docs/api/interfaces/Article.md
View File

@ -33,7 +33,7 @@
#### Defined in
[lib/types/Article.ts:16](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L16)
[lib/types/Article.ts:16](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L16)
___
@ -43,7 +43,7 @@ ___
#### Defined in
[lib/types/Article.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L10)
[lib/types/Article.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L10)
___
@ -53,7 +53,7 @@ ___
#### Defined in
[lib/types/Article.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L9)
[lib/types/Article.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L9)
___
@ -63,7 +63,7 @@ ___
#### Defined in
[lib/types/Article.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L6)
[lib/types/Article.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L6)
___
@ -81,7 +81,7 @@ ___
#### Defined in
[lib/types/Article.ts:11](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L11)
[lib/types/Article.ts:11](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L11)
___
@ -91,7 +91,7 @@ ___
#### Defined in
[lib/types/Article.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L8)
[lib/types/Article.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L8)
___
@ -101,7 +101,7 @@ ___
#### Defined in
[lib/types/Article.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L20)
[lib/types/Article.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L20)
___
@ -119,7 +119,7 @@ ___
#### Defined in
[lib/types/Article.ts:22](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L22)
[lib/types/Article.ts:22](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L22)
___
@ -129,7 +129,7 @@ ___
#### Defined in
[lib/types/Article.ts:21](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L21)
[lib/types/Article.ts:21](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L21)
___
@ -139,7 +139,7 @@ ___
#### Defined in
[lib/types/Article.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L5)
[lib/types/Article.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L5)
___
@ -149,4 +149,4 @@ ___
#### Defined in
[lib/types/Article.ts:7](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L7)
[lib/types/Article.ts:7](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L7)

8
docs/api/interfaces/ArticleAPIGetArticleParams.md
View File

@ -19,7 +19,7 @@
#### Defined in
[lib/article/ArticleAPI.ts:14](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/article/ArticleAPI.ts#L14)
[lib/article/ArticleAPI.ts:13](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/article/ArticleAPI.ts#L13)
___
@ -29,7 +29,7 @@ ___
#### Defined in
[lib/article/ArticleAPI.ts:13](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/article/ArticleAPI.ts#L13)
[lib/article/ArticleAPI.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/article/ArticleAPI.ts#L12)
___
@ -39,7 +39,7 @@ ___
#### Defined in
[lib/article/ArticleAPI.ts:15](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/article/ArticleAPI.ts#L15)
[lib/article/ArticleAPI.ts:14](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/article/ArticleAPI.ts#L14)
___
@ -49,4 +49,4 @@ ___
#### Defined in
[lib/article/ArticleAPI.ts:16](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/article/ArticleAPI.ts#L16)
[lib/article/ArticleAPI.ts:15](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/article/ArticleAPI.ts#L15)

6
docs/api/interfaces/ArticleAPIListParams.md
View File

@ -18,7 +18,7 @@
#### Defined in
[lib/article/ArticleAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/article/ArticleAPI.ts#L20)
[lib/article/ArticleAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/article/ArticleAPI.ts#L19)
___
@ -28,7 +28,7 @@ ___
#### Defined in
[lib/article/ArticleAPI.ts:21](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/article/ArticleAPI.ts#L21)
[lib/article/ArticleAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/article/ArticleAPI.ts#L20)
___
@ -38,4 +38,4 @@ ___
#### Defined in
[lib/article/ArticleAPI.ts:22](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/article/ArticleAPI.ts#L22)
[lib/article/ArticleAPI.ts:21](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/article/ArticleAPI.ts#L21)

4
docs/api/interfaces/ArticleCategory.md
View File

@ -17,7 +17,7 @@
#### Defined in
[lib/types/Article.ts:30](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L30)
[lib/types/Article.ts:30](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L30)
___
@ -27,4 +27,4 @@ ___
#### Defined in
[lib/types/Article.ts:31](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L31)
[lib/types/Article.ts:31](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L31)

8
docs/api/interfaces/ArticleCategorySection.md
View File

@ -19,7 +19,7 @@
#### Defined in
[lib/types/Article.ts:38](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L38)
[lib/types/Article.ts:38](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L38)
___
@ -29,7 +29,7 @@ ___
#### Defined in
[lib/types/Article.ts:35](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L35)
[lib/types/Article.ts:35](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L35)
___
@ -39,7 +39,7 @@ ___
#### Defined in
[lib/types/Article.ts:37](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L37)
[lib/types/Article.ts:37](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L37)
___
@ -49,4 +49,4 @@ ___
#### Defined in
[lib/types/Article.ts:36](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L36)
[lib/types/Article.ts:36](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L36)

8
docs/api/interfaces/ArticleList.md
View File

@ -19,7 +19,7 @@
#### Defined in
[lib/types/Article.ts:57](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L57)
[lib/types/Article.ts:57](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L57)
___
@ -29,7 +29,7 @@ ___
#### Defined in
[lib/types/Article.ts:60](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L60)
[lib/types/Article.ts:60](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L60)
___
@ -39,7 +39,7 @@ ___
#### Defined in
[lib/types/Article.ts:59](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L59)
[lib/types/Article.ts:59](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L59)
___
@ -49,4 +49,4 @@ ___
#### Defined in
[lib/types/Article.ts:58](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L58)
[lib/types/Article.ts:58](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L58)

10
docs/api/interfaces/ArticleListItem.md
View File

@ -20,7 +20,7 @@
#### Defined in
[lib/types/Article.ts:67](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L67)
[lib/types/Article.ts:67](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L67)
___
@ -30,7 +30,7 @@ ___
#### Defined in
[lib/types/Article.ts:66](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L66)
[lib/types/Article.ts:66](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L66)
___
@ -40,7 +40,7 @@ ___
#### Defined in
[lib/types/Article.ts:68](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L68)
[lib/types/Article.ts:68](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L68)
___
@ -50,7 +50,7 @@ ___
#### Defined in
[lib/types/Article.ts:65](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L65)
[lib/types/Article.ts:65](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L65)
___
@ -60,4 +60,4 @@ ___
#### Defined in
[lib/types/Article.ts:64](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L64)
[lib/types/Article.ts:64](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L64)

8
docs/api/interfaces/ArticleSection.md
View File

@ -26,7 +26,7 @@
#### Defined in
[lib/types/Article.ts:42](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L42)
[lib/types/Article.ts:42](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L42)
___
@ -36,7 +36,7 @@ ___
#### Defined in
[lib/types/Article.ts:46](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L46)
[lib/types/Article.ts:46](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L46)
___
@ -46,7 +46,7 @@ ___
#### Defined in
[lib/types/Article.ts:48](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L48)
[lib/types/Article.ts:48](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L48)
___
@ -56,4 +56,4 @@ ___
#### Defined in
[lib/types/Article.ts:47](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Article.ts#L47)
[lib/types/Article.ts:47](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Article.ts#L47)

16
docs/api/interfaces/Artist.md
View File

@ -33,7 +33,7 @@
#### Defined in
[lib/types/UserKind.ts:3](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/UserKind.ts#L3)
[lib/types/UserKind.ts:3](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/UserKind.ts#L3)
___
@ -43,7 +43,7 @@ ___
#### Defined in
[lib/types/Artist.ts:7](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Artist.ts#L7)
[lib/types/Artist.ts:7](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Artist.ts#L7)
___
@ -57,7 +57,7 @@ ___
#### Defined in
[lib/types/UserKind.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/UserKind.ts#L5)
[lib/types/UserKind.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/UserKind.ts#L5)
___
@ -67,7 +67,7 @@ ___
#### Defined in
[lib/types/Artist.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Artist.ts#L6)
[lib/types/Artist.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Artist.ts#L6)
___
@ -81,7 +81,7 @@ ___
#### Defined in
[lib/types/UserKind.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/UserKind.ts#L6)
[lib/types/UserKind.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/UserKind.ts#L6)
___
@ -95,7 +95,7 @@ ___
#### Defined in
[lib/types/UserKind.ts:2](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/UserKind.ts#L2)
[lib/types/UserKind.ts:2](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/UserKind.ts#L2)
___
@ -105,7 +105,7 @@ ___
#### Defined in
[lib/types/Artist.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Artist.ts#L5)
[lib/types/Artist.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Artist.ts#L5)
___
@ -119,4 +119,4 @@ ___
#### Defined in
[lib/types/UserKind.ts:4](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/UserKind.ts#L4)
[lib/types/UserKind.ts:4](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/UserKind.ts#L4)

8
docs/api/interfaces/AutoCompleteTag.md
View File

@ -25,7 +25,7 @@
#### Defined in
[lib/types/Autocomplete.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Autocomplete.ts#L8)
[lib/types/Autocomplete.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Autocomplete.ts#L8)
___
@ -39,7 +39,7 @@ ___
#### Defined in
[lib/types/Autocomplete.ts:3](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Autocomplete.ts#L3)
[lib/types/Autocomplete.ts:3](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Autocomplete.ts#L3)
___
@ -53,7 +53,7 @@ ___
#### Defined in
[lib/types/Autocomplete.ts:7](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Autocomplete.ts#L7)
[lib/types/Autocomplete.ts:7](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Autocomplete.ts#L7)
___
@ -63,4 +63,4 @@ ___
#### Defined in
[lib/types/Autocomplete.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Autocomplete.ts#L9)
[lib/types/Autocomplete.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Autocomplete.ts#L9)

6
docs/api/interfaces/AutocompleteAPIGetSuggestionsParams.md
View File

@ -18,7 +18,7 @@
#### Defined in
[lib/autocomplete/AutocompleteAPI.ts:14](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/autocomplete/AutocompleteAPI.ts#L14)
[lib/autocomplete/AutocompleteAPI.ts:15](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/autocomplete/AutocompleteAPI.ts#L15)
___
@ -28,7 +28,7 @@ ___
#### Defined in
[lib/autocomplete/AutocompleteAPI.ts:15](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/autocomplete/AutocompleteAPI.ts#L15)
[lib/autocomplete/AutocompleteAPI.ts:16](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/autocomplete/AutocompleteAPI.ts#L16)
___
@ -38,4 +38,4 @@ ___
#### Defined in
[lib/autocomplete/AutocompleteAPI.ts:13](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/autocomplete/AutocompleteAPI.ts#L13)
[lib/autocomplete/AutocompleteAPI.ts:14](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/autocomplete/AutocompleteAPI.ts#L14)

4
docs/api/interfaces/AutocompleteItem.md
View File

@ -25,7 +25,7 @@
#### Defined in
[lib/types/Autocomplete.ts:3](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Autocomplete.ts#L3)
[lib/types/Autocomplete.ts:3](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Autocomplete.ts#L3)
___
@ -35,4 +35,4 @@ ___
#### Defined in
[lib/types/Autocomplete.ts:2](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Autocomplete.ts#L2)
[lib/types/Autocomplete.ts:2](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Autocomplete.ts#L2)

8
docs/api/interfaces/AutocompleteLocation.md
View File

@ -25,7 +25,7 @@
#### Defined in
[lib/types/Autocomplete.ts:14](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Autocomplete.ts#L14)
[lib/types/Autocomplete.ts:14](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Autocomplete.ts#L14)
___
@ -39,7 +39,7 @@ ___
#### Defined in
[lib/types/Autocomplete.ts:3](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Autocomplete.ts#L3)
[lib/types/Autocomplete.ts:3](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Autocomplete.ts#L3)
___
@ -53,7 +53,7 @@ ___
#### Defined in
[lib/types/Autocomplete.ts:13](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Autocomplete.ts#L13)
[lib/types/Autocomplete.ts:13](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Autocomplete.ts#L13)
___
@ -63,4 +63,4 @@ ___
#### Defined in
[lib/types/Autocomplete.ts:15](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Autocomplete.ts#L15)
[lib/types/Autocomplete.ts:15](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Autocomplete.ts#L15)

4
docs/api/interfaces/BandAPIGetDiscographyParams.md
View File

@ -17,7 +17,7 @@
#### Defined in
[lib/band/BandAPI.ts:15](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/band/BandAPI.ts#L15)
[lib/band/BandAPI.ts:14](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/band/BandAPI.ts#L14)
___
@ -27,4 +27,4 @@ ___
#### Defined in
[lib/band/BandAPI.ts:16](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/band/BandAPI.ts#L16)
[lib/band/BandAPI.ts:15](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/band/BandAPI.ts#L15)

6
docs/api/interfaces/BandAPIGetInfoParams.md
View File

@ -18,7 +18,7 @@
#### Defined in
[lib/band/BandAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/band/BandAPI.ts#L20)
[lib/band/BandAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/band/BandAPI.ts#L19)
___
@ -28,7 +28,7 @@ ___
#### Defined in
[lib/band/BandAPI.ts:21](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/band/BandAPI.ts#L21)
[lib/band/BandAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/band/BandAPI.ts#L20)
___
@ -38,4 +38,4 @@ ___
#### Defined in
[lib/band/BandAPI.ts:22](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/band/BandAPI.ts#L22)
[lib/band/BandAPI.ts:21](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/band/BandAPI.ts#L21)

4
docs/api/interfaces/BandAPIGetLabelArtistsParams.md
View File

@ -17,7 +17,7 @@
#### Defined in
[lib/band/BandAPI.ts:27](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/band/BandAPI.ts#L27)
[lib/band/BandAPI.ts:26](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/band/BandAPI.ts#L26)
___
@ -27,4 +27,4 @@ ___
#### Defined in
[lib/band/BandAPI.ts:26](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/band/BandAPI.ts#L26)
[lib/band/BandAPI.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/band/BandAPI.ts#L25)

19
docs/api/interfaces/BandcampFetchParams.md Normal file
View File

@ -0,0 +1,19 @@
[bandcamp-fetch](../README.md) / BandcampFetchParams
# Interface: BandcampFetchParams
## Table of contents
### Properties
- [cookie](BandcampFetchParams.md#cookie)
## Properties
### cookie
• `Optional` **cookie**: ``null`` \| `string`
#### Defined in
[lib/BandcampFetch.ts:18](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/BandcampFetch.ts#L18)

36
docs/api/interfaces/BaseAPIParams.md Normal file
View File

@ -0,0 +1,36 @@
[bandcamp-fetch](../README.md) / BaseAPIParams
# Interface: BaseAPIParams
## Hierarchy
- **`BaseAPIParams`**
↳ [`BaseAPIWithImageSupportParams`](BaseAPIWithImageSupportParams.md)
## Table of contents
### Properties
- [cache](BaseAPIParams.md#cache)
- [fetcher](BaseAPIParams.md#fetcher)
## Properties
### cache
• **cache**: [`Cache`](../classes/Cache.md)
#### Defined in
[lib/common/BaseAPI.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L6)
___
### fetcher
• **fetcher**: [`Fetcher`](../classes/Fetcher.md)
#### Defined in
[lib/common/BaseAPI.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L5)

55
docs/api/interfaces/BaseAPIWithImageSupportParams.md Normal file
View File

@ -0,0 +1,55 @@
[bandcamp-fetch](../README.md) / BaseAPIWithImageSupportParams
# Interface: BaseAPIWithImageSupportParams
## Hierarchy
- [`BaseAPIParams`](BaseAPIParams.md)
↳ **`BaseAPIWithImageSupportParams`**
## Table of contents
### Properties
- [cache](BaseAPIWithImageSupportParams.md#cache)
- [fetcher](BaseAPIWithImageSupportParams.md#fetcher)
- [imageAPI](BaseAPIWithImageSupportParams.md#imageapi)
## Properties
### cache
• **cache**: [`Cache`](../classes/Cache.md)
#### Inherited from
[BaseAPIParams](BaseAPIParams.md).[cache](BaseAPIParams.md#cache)
#### Defined in
[lib/common/BaseAPI.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L6)
___
### fetcher
• **fetcher**: [`Fetcher`](../classes/Fetcher.md)
#### Inherited from
[BaseAPIParams](BaseAPIParams.md).[fetcher](BaseAPIParams.md#fetcher)
#### Defined in
[lib/common/BaseAPI.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPI.ts#L5)
___
### imageAPI
• **imageAPI**: [`ImageAPI`](../classes/ImageAPI.md)
#### Defined in
[lib/common/BaseAPIWithImageSupport.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/common/BaseAPIWithImageSupport.ts#L5)

14
docs/api/interfaces/DiscoverOptions.md
View File

@ -28,7 +28,7 @@ DiscoveryAPI.getAvailableOptions
#### Defined in
[lib/types/Discovery.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Discovery.ts#L17)
[lib/types/Discovery.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Discovery.ts#L17)
___
@ -38,7 +38,7 @@ ___
#### Defined in
[lib/types/Discovery.ts:16](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Discovery.ts#L16)
[lib/types/Discovery.ts:16](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Discovery.ts#L16)
___
@ -48,7 +48,7 @@ ___
#### Defined in
[lib/types/Discovery.ts:11](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Discovery.ts#L11)
[lib/types/Discovery.ts:11](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Discovery.ts#L11)
___
@ -58,7 +58,7 @@ ___
#### Defined in
[lib/types/Discovery.ts:15](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Discovery.ts#L15)
[lib/types/Discovery.ts:15](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Discovery.ts#L15)
___
@ -68,7 +68,7 @@ ___
#### Defined in
[lib/types/Discovery.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Discovery.ts#L12)
[lib/types/Discovery.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Discovery.ts#L12)
___
@ -78,7 +78,7 @@ ___
#### Defined in
[lib/types/Discovery.ts:14](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Discovery.ts#L14)
[lib/types/Discovery.ts:14](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Discovery.ts#L14)
___
@ -88,4 +88,4 @@ ___
#### Defined in
[lib/types/Discovery.ts:13](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Discovery.ts#L13)
[lib/types/Discovery.ts:13](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Discovery.ts#L13)

20
docs/api/interfaces/DiscoverParams.md
View File

@ -33,7 +33,7 @@ Value indicating the image format to adopt when constructing image URLs of disco
#### Defined in
[lib/types/Discovery.ts:37](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Discovery.ts#L37)
[lib/types/Discovery.ts:37](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Discovery.ts#L37)
___
@ -45,7 +45,7 @@ Value indicating the image format to adopt when constructing image URLs of album
#### Defined in
[lib/types/Discovery.ts:41](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Discovery.ts#L41)
[lib/types/Discovery.ts:41](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Discovery.ts#L41)
___
@ -55,7 +55,7 @@ ___
#### Defined in
[lib/types/Discovery.ts:33](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Discovery.ts#L33)
[lib/types/Discovery.ts:33](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Discovery.ts#L33)
___
@ -65,7 +65,7 @@ ___
#### Defined in
[lib/types/Discovery.ts:32](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Discovery.ts#L32)
[lib/types/Discovery.ts:32](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Discovery.ts#L32)
___
@ -75,7 +75,7 @@ ___
#### Defined in
[lib/types/Discovery.ts:26](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Discovery.ts#L26)
[lib/types/Discovery.ts:26](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Discovery.ts#L26)
___
@ -85,7 +85,7 @@ ___
#### Defined in
[lib/types/Discovery.ts:31](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Discovery.ts#L31)
[lib/types/Discovery.ts:31](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Discovery.ts#L31)
___
@ -95,7 +95,7 @@ ___
#### Defined in
[lib/types/Discovery.ts:28](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Discovery.ts#L28)
[lib/types/Discovery.ts:28](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Discovery.ts#L28)
___
@ -105,7 +105,7 @@ ___
#### Defined in
[lib/types/Discovery.ts:27](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Discovery.ts#L27)
[lib/types/Discovery.ts:27](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Discovery.ts#L27)
___
@ -115,7 +115,7 @@ ___
#### Defined in
[lib/types/Discovery.ts:30](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Discovery.ts#L30)
[lib/types/Discovery.ts:30](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Discovery.ts#L30)
___
@ -125,4 +125,4 @@ ___
#### Defined in
[lib/types/Discovery.ts:29](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Discovery.ts#L29)
[lib/types/Discovery.ts:29](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Discovery.ts#L29)

6
docs/api/interfaces/DiscoverResult.md
View File

@ -22,7 +22,7 @@ List of discovered albums.
#### Defined in
[lib/types/Discovery.ts:51](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Discovery.ts#L51)
[lib/types/Discovery.ts:51](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Discovery.ts#L51)
___
@ -34,7 +34,7 @@ Sanitized params used in the discovery request.
#### Defined in
[lib/types/Discovery.ts:59](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Discovery.ts#L59)
[lib/types/Discovery.ts:59](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Discovery.ts#L59)
___
@ -46,4 +46,4 @@ Total number of albums discovered.
#### Defined in
[lib/types/Discovery.ts:55](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Discovery.ts#L55)
[lib/types/Discovery.ts:55](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Discovery.ts#L55)

24
docs/api/interfaces/Fan.md
View File

@ -33,7 +33,7 @@
#### Defined in
[lib/types/Fan.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Fan.ts#L10)
[lib/types/Fan.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Fan.ts#L10)
___
@ -47,7 +47,7 @@ ___
#### Defined in
[lib/types/UserKind.ts:3](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/UserKind.ts#L3)
[lib/types/UserKind.ts:3](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/UserKind.ts#L3)
___
@ -57,7 +57,7 @@ ___
#### Defined in
[lib/types/Fan.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Fan.ts#L8)
[lib/types/Fan.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Fan.ts#L8)
___
@ -67,7 +67,7 @@ ___
#### Defined in
[lib/types/Fan.ts:7](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Fan.ts#L7)
[lib/types/Fan.ts:7](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Fan.ts#L7)
___
@ -81,7 +81,7 @@ ___
#### Defined in
[lib/types/UserKind.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/UserKind.ts#L5)
[lib/types/UserKind.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/UserKind.ts#L5)
___
@ -95,7 +95,7 @@ ___
#### Defined in
[lib/types/UserKind.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/UserKind.ts#L6)
[lib/types/UserKind.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/UserKind.ts#L6)
___
@ -109,7 +109,7 @@ ___
#### Defined in
[lib/types/UserKind.ts:2](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/UserKind.ts#L2)
[lib/types/UserKind.ts:2](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/UserKind.ts#L2)
___
@ -119,7 +119,7 @@ ___
#### Defined in
[lib/types/Fan.ts:4](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Fan.ts#L4)
[lib/types/Fan.ts:4](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Fan.ts#L4)
___
@ -133,7 +133,7 @@ ___
#### Defined in
[lib/types/UserKind.ts:4](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/UserKind.ts#L4)
[lib/types/UserKind.ts:4](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/UserKind.ts#L4)
___
@ -143,7 +143,7 @@ ___
#### Defined in
[lib/types/Fan.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Fan.ts#L5)
[lib/types/Fan.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Fan.ts#L5)
___
@ -153,7 +153,7 @@ ___
#### Defined in
[lib/types/Fan.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Fan.ts#L6)
[lib/types/Fan.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Fan.ts#L6)
___
@ -163,4 +163,4 @@ ___
#### Defined in
[lib/types/Fan.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Fan.ts#L9)
[lib/types/Fan.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Fan.ts#L9)

4
docs/api/interfaces/FanAPIGetInfoParams.md
View File

@ -17,7 +17,7 @@
#### Defined in
[lib/fan/FanAPI.ts:21](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/fan/FanAPI.ts#L21)
[lib/fan/FanAPI.ts:21](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/fan/FanAPI.ts#L21)
___
@ -27,4 +27,4 @@ ___
#### Defined in
[lib/fan/FanAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/fan/FanAPI.ts#L20)
[lib/fan/FanAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/fan/FanAPI.ts#L20)

4
docs/api/interfaces/FanAPIGetItemsParams.md
View File

@ -17,7 +17,7 @@
#### Defined in
[lib/fan/FanAPI.ts:26](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/fan/FanAPI.ts#L26)
[lib/fan/FanAPI.ts:26](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/fan/FanAPI.ts#L26)
___
@ -27,4 +27,4 @@ ___
#### Defined in
[lib/fan/FanAPI.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/fan/FanAPI.ts#L25)
[lib/fan/FanAPI.ts:25](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/fan/FanAPI.ts#L25)

4
docs/api/interfaces/FanContinuationItemsResult.md
View File

@ -23,7 +23,7 @@
#### Defined in
[lib/fan/FanItemsBaseParser.ts:22](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/fan/FanItemsBaseParser.ts#L22)
[lib/fan/FanItemsBaseParser.ts:22](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/fan/FanItemsBaseParser.ts#L22)
___
@ -33,4 +33,4 @@ ___
#### Defined in
[lib/fan/FanItemsBaseParser.ts:21](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/fan/FanItemsBaseParser.ts#L21)
[lib/fan/FanItemsBaseParser.ts:21](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/fan/FanItemsBaseParser.ts#L21)

4
docs/api/interfaces/FanItemsContinuation.md
View File

@ -17,7 +17,7 @@
#### Defined in
[lib/types/Fan.ts:14](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Fan.ts#L14)
[lib/types/Fan.ts:14](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Fan.ts#L14)
___
@ -27,4 +27,4 @@ ___
#### Defined in
[lib/types/Fan.ts:15](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Fan.ts#L15)
[lib/types/Fan.ts:15](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Fan.ts#L15)

6
docs/api/interfaces/FanPageItemsResult.md
View File

@ -24,7 +24,7 @@
#### Defined in
[lib/fan/FanItemsBaseParser.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/fan/FanItemsBaseParser.ts#L17)
[lib/fan/FanItemsBaseParser.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/fan/FanItemsBaseParser.ts#L17)
___
@ -34,7 +34,7 @@ ___
#### Defined in
[lib/fan/FanItemsBaseParser.ts:15](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/fan/FanItemsBaseParser.ts#L15)
[lib/fan/FanItemsBaseParser.ts:15](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/fan/FanItemsBaseParser.ts#L15)
___
@ -44,4 +44,4 @@ ___
#### Defined in
[lib/fan/FanItemsBaseParser.ts:16](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/fan/FanItemsBaseParser.ts#L16)
[lib/fan/FanItemsBaseParser.ts:16](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/fan/FanItemsBaseParser.ts#L16)

30
docs/api/interfaces/FetcherParams.md Normal file
View File

@ -0,0 +1,30 @@
[bandcamp-fetch](../README.md) / FetcherParams
# Interface: FetcherParams
## Table of contents
### Properties
- [cache](FetcherParams.md#cache)
- [cookie](FetcherParams.md#cookie)
## Properties
### cache
• **cache**: [`Cache`](../classes/Cache.md)
#### Defined in
[lib/utils/Fetcher.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/Fetcher.ts#L12)
___
### cookie
• `Optional` **cookie**: ``null`` \| `string`
#### Defined in
[lib/utils/Fetcher.ts:11](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/Fetcher.ts#L11)

4
docs/api/interfaces/ImageConstants.md
View File

@ -17,7 +17,7 @@
#### Defined in
[lib/types/Image.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Image.ts#L10)
[lib/types/Image.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Image.ts#L10)
___
@ -27,4 +27,4 @@ ___
#### Defined in
[lib/types/Image.ts:11](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Image.ts#L11)
[lib/types/Image.ts:11](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Image.ts#L11)

10
docs/api/interfaces/ImageFormat.md
View File

@ -20,7 +20,7 @@
#### Defined in
[lib/types/Image.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Image.ts#L6)
[lib/types/Image.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Image.ts#L6)
___
@ -30,7 +30,7 @@ ___
#### Defined in
[lib/types/Image.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Image.ts#L5)
[lib/types/Image.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Image.ts#L5)
___
@ -40,7 +40,7 @@ ___
#### Defined in
[lib/types/Image.ts:2](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Image.ts#L2)
[lib/types/Image.ts:2](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Image.ts#L2)
___
@ -50,7 +50,7 @@ ___
#### Defined in
[lib/types/Image.ts:3](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Image.ts#L3)
[lib/types/Image.ts:3](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Image.ts#L3)
___
@ -60,4 +60,4 @@ ___
#### Defined in
[lib/types/Image.ts:4](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Image.ts#L4)
[lib/types/Image.ts:4](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Image.ts#L4)

14
docs/api/interfaces/Label.md
View File

@ -32,7 +32,7 @@
#### Defined in
[lib/types/UserKind.ts:3](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/UserKind.ts#L3)
[lib/types/UserKind.ts:3](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/UserKind.ts#L3)
___
@ -46,7 +46,7 @@ ___
#### Defined in
[lib/types/UserKind.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/UserKind.ts#L5)
[lib/types/UserKind.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/UserKind.ts#L5)
___
@ -56,7 +56,7 @@ ___
#### Defined in
[lib/types/Label.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Label.ts#L6)
[lib/types/Label.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Label.ts#L6)
___
@ -70,7 +70,7 @@ ___
#### Defined in
[lib/types/UserKind.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/UserKind.ts#L6)
[lib/types/UserKind.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/UserKind.ts#L6)
___
@ -84,7 +84,7 @@ ___
#### Defined in
[lib/types/UserKind.ts:2](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/UserKind.ts#L2)
[lib/types/UserKind.ts:2](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/UserKind.ts#L2)
___
@ -94,7 +94,7 @@ ___
#### Defined in
[lib/types/Label.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Label.ts#L5)
[lib/types/Label.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Label.ts#L5)
___
@ -108,4 +108,4 @@ ___
#### Defined in
[lib/types/UserKind.ts:4](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/UserKind.ts#L4)
[lib/types/UserKind.ts:4](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/UserKind.ts#L4)

16
docs/api/interfaces/MediaKind.md
View File

@ -31,7 +31,7 @@
#### Defined in
[lib/types/MediaKind.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/MediaKind.ts#L10)
[lib/types/MediaKind.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/MediaKind.ts#L10)
___
@ -41,7 +41,7 @@ ___
#### Defined in
[lib/types/MediaKind.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/MediaKind.ts#L8)
[lib/types/MediaKind.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/MediaKind.ts#L8)
___
@ -51,7 +51,7 @@ ___
#### Defined in
[lib/types/MediaKind.ts:11](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/MediaKind.ts#L11)
[lib/types/MediaKind.ts:11](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/MediaKind.ts#L11)
___
@ -61,7 +61,7 @@ ___
#### Defined in
[lib/types/MediaKind.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/MediaKind.ts#L6)
[lib/types/MediaKind.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/MediaKind.ts#L6)
___
@ -71,7 +71,7 @@ ___
#### Defined in
[lib/types/MediaKind.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/MediaKind.ts#L12)
[lib/types/MediaKind.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/MediaKind.ts#L12)
___
@ -88,7 +88,7 @@ ___
#### Defined in
[lib/types/MediaKind.ts:13](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/MediaKind.ts#L13)
[lib/types/MediaKind.ts:13](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/MediaKind.ts#L13)
___
@ -98,7 +98,7 @@ ___
#### Defined in
[lib/types/MediaKind.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/MediaKind.ts#L9)
[lib/types/MediaKind.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/MediaKind.ts#L9)
___
@ -108,4 +108,4 @@ ___
#### Defined in
[lib/types/MediaKind.ts:7](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/MediaKind.ts#L7)
[lib/types/MediaKind.ts:7](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/MediaKind.ts#L7)

4
docs/api/interfaces/NameValuePair.md
View File

@ -29,7 +29,7 @@
#### Defined in
[lib/utils/NameValuePair.ts:2](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/utils/NameValuePair.ts#L2)
[lib/utils/NameValuePair.ts:2](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/NameValuePair.ts#L2)
___
@ -39,4 +39,4 @@ ___
#### Defined in
[lib/utils/NameValuePair.ts:3](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/utils/NameValuePair.ts#L3)
[lib/utils/NameValuePair.ts:3](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/NameValuePair.ts#L3)

6
docs/api/interfaces/ReleasesByTag-1.md
View File

@ -18,7 +18,7 @@
#### Defined in
[lib/types/Tag.ts:47](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Tag.ts#L47)
[lib/types/Tag.ts:47](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Tag.ts#L47)
___
@ -28,7 +28,7 @@ ___
#### Defined in
[lib/types/Tag.ts:46](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Tag.ts#L46)
[lib/types/Tag.ts:46](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Tag.ts#L46)
___
@ -38,4 +38,4 @@ ___
#### Defined in
[lib/types/Tag.ts:45](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Tag.ts#L45)
[lib/types/Tag.ts:45](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Tag.ts#L45)

4
docs/api/interfaces/ReleasesByTag.Filter.md
View File

@ -19,7 +19,7 @@
#### Defined in
[lib/types/Tag.ts:39](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Tag.ts#L39)
[lib/types/Tag.ts:39](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Tag.ts#L39)
___
@ -29,4 +29,4 @@ ___
#### Defined in
[lib/types/Tag.ts:40](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Tag.ts#L40)
[lib/types/Tag.ts:40](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Tag.ts#L40)

8
docs/api/interfaces/ReleasesByTag.FilterOption.md
View File

@ -27,7 +27,7 @@
#### Defined in
[lib/types/Tag.ts:34](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Tag.ts#L34)
[lib/types/Tag.ts:34](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Tag.ts#L34)
___
@ -41,7 +41,7 @@ ___
#### Defined in
[lib/utils/NameValuePair.ts:2](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/utils/NameValuePair.ts#L2)
[lib/utils/NameValuePair.ts:2](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/NameValuePair.ts#L2)
___
@ -51,7 +51,7 @@ ___
#### Defined in
[lib/types/Tag.ts:35](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Tag.ts#L35)
[lib/types/Tag.ts:35](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Tag.ts#L35)
___
@ -65,4 +65,4 @@ ___
#### Defined in
[lib/utils/NameValuePair.ts:3](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/utils/NameValuePair.ts#L3)
[lib/utils/NameValuePair.ts:3](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/utils/NameValuePair.ts#L3)

8
docs/api/interfaces/SearchAPISearchParams.md
View File

@ -19,7 +19,7 @@
#### Defined in
[lib/search/SearchAPI.ts:21](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/search/SearchAPI.ts#L21)
[lib/search/SearchAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L20)
___
@ -29,7 +29,7 @@ ___
#### Defined in
[lib/search/SearchAPI.ts:22](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/search/SearchAPI.ts#L22)
[lib/search/SearchAPI.ts:21](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L21)
___
@ -39,7 +39,7 @@ ___
#### Defined in
[lib/search/SearchAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/search/SearchAPI.ts#L20)
[lib/search/SearchAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L19)
___
@ -49,4 +49,4 @@ ___
#### Defined in
[lib/search/SearchAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/search/SearchAPI.ts#L19)
[lib/search/SearchAPI.ts:18](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/search/SearchAPI.ts#L18)

18
docs/api/interfaces/SearchResultAlbum.md
View File

@ -30,7 +30,7 @@
#### Defined in
[lib/types/Search.ts:27](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L27)
[lib/types/Search.ts:27](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L27)
___
@ -40,7 +40,7 @@ ___
#### Defined in
[lib/types/Search.ts:29](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L29)
[lib/types/Search.ts:29](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L29)
___
@ -54,7 +54,7 @@ ___
#### Defined in
[lib/types/Search.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L10)
[lib/types/Search.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L10)
___
@ -68,7 +68,7 @@ ___
#### Defined in
[lib/types/Search.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L8)
[lib/types/Search.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L8)
___
@ -78,7 +78,7 @@ ___
#### Defined in
[lib/types/Search.ts:28](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L28)
[lib/types/Search.ts:28](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L28)
___
@ -88,7 +88,7 @@ ___
#### Defined in
[lib/types/Search.ts:30](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L30)
[lib/types/Search.ts:30](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L30)
___
@ -98,7 +98,7 @@ ___
#### Defined in
[lib/types/Search.ts:31](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L31)
[lib/types/Search.ts:31](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L31)
___
@ -112,7 +112,7 @@ ___
#### Defined in
[lib/types/Search.ts:26](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L26)
[lib/types/Search.ts:26](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L26)
___
@ -126,4 +126,4 @@ ___
#### Defined in
[lib/types/Search.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L9)
[lib/types/Search.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L9)

14
docs/api/interfaces/SearchResultArtist.md
View File

@ -28,7 +28,7 @@
#### Defined in
[lib/types/Search.ts:16](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L16)
[lib/types/Search.ts:16](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L16)
___
@ -42,7 +42,7 @@ ___
#### Defined in
[lib/types/Search.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L10)
[lib/types/Search.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L10)
___
@ -52,7 +52,7 @@ ___
#### Defined in
[lib/types/Search.ts:15](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L15)
[lib/types/Search.ts:15](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L15)
___
@ -66,7 +66,7 @@ ___
#### Defined in
[lib/types/Search.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L8)
[lib/types/Search.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L8)
___
@ -76,7 +76,7 @@ ___
#### Defined in
[lib/types/Search.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L17)
[lib/types/Search.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L17)
___
@ -90,7 +90,7 @@ ___
#### Defined in
[lib/types/Search.ts:14](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L14)
[lib/types/Search.ts:14](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L14)
___
@ -104,4 +104,4 @@ ___
#### Defined in
[lib/types/Search.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L9)
[lib/types/Search.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L9)

10
docs/api/interfaces/SearchResultFan.md
View File

@ -26,7 +26,7 @@
#### Defined in
[lib/types/Search.ts:44](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L44)
[lib/types/Search.ts:44](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L44)
___
@ -40,7 +40,7 @@ ___
#### Defined in
[lib/types/Search.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L10)
[lib/types/Search.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L10)
___
@ -54,7 +54,7 @@ ___
#### Defined in
[lib/types/Search.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L8)
[lib/types/Search.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L8)
___
@ -68,7 +68,7 @@ ___
#### Defined in
[lib/types/Search.ts:43](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L43)
[lib/types/Search.ts:43](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L43)
___
@ -82,4 +82,4 @@ ___
#### Defined in
[lib/types/Search.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L9)
[lib/types/Search.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L9)

8
docs/api/interfaces/SearchResultItem.md
View File

@ -33,7 +33,7 @@
#### Defined in
[lib/types/Search.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L10)
[lib/types/Search.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L10)
___
@ -43,7 +43,7 @@ ___
#### Defined in
[lib/types/Search.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L8)
[lib/types/Search.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L8)
___
@ -53,7 +53,7 @@ ___
#### Defined in
[lib/types/Search.ts:7](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L7)
[lib/types/Search.ts:7](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L7)
___
@ -63,4 +63,4 @@ ___
#### Defined in
[lib/types/Search.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L9)
[lib/types/Search.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L9)

10
docs/api/interfaces/SearchResultLabel.md
View File

@ -30,7 +30,7 @@
#### Defined in
[lib/types/Search.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L10)
[lib/types/Search.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L10)
___
@ -40,7 +40,7 @@ ___
#### Defined in
[lib/types/Search.ts:22](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L22)
[lib/types/Search.ts:22](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L22)
___
@ -54,7 +54,7 @@ ___
#### Defined in
[lib/types/Search.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L8)
[lib/types/Search.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L8)
___
@ -68,7 +68,7 @@ ___
#### Defined in
[lib/types/Search.ts:21](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L21)
[lib/types/Search.ts:21](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L21)
___
@ -82,4 +82,4 @@ ___
#### Defined in
[lib/types/Search.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L9)
[lib/types/Search.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L9)

16
docs/api/interfaces/SearchResultTrack.md
View File

@ -29,7 +29,7 @@
#### Defined in
[lib/types/Search.ts:37](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L37)
[lib/types/Search.ts:37](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L37)
___
@ -39,7 +39,7 @@ ___
#### Defined in
[lib/types/Search.ts:36](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L36)
[lib/types/Search.ts:36](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L36)
___
@ -53,7 +53,7 @@ ___
#### Defined in
[lib/types/Search.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L10)
[lib/types/Search.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L10)
___
@ -67,7 +67,7 @@ ___
#### Defined in
[lib/types/Search.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L8)
[lib/types/Search.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L8)
___
@ -77,7 +77,7 @@ ___
#### Defined in
[lib/types/Search.ts:38](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L38)
[lib/types/Search.ts:38](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L38)
___
@ -87,7 +87,7 @@ ___
#### Defined in
[lib/types/Search.ts:39](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L39)
[lib/types/Search.ts:39](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L39)
___
@ -101,7 +101,7 @@ ___
#### Defined in
[lib/types/Search.ts:35](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L35)
[lib/types/Search.ts:35](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L35)
___
@ -115,4 +115,4 @@ ___
#### Defined in
[lib/types/Search.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L9)
[lib/types/Search.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L9)

4
docs/api/interfaces/SearchResults.md
View File

@ -23,7 +23,7 @@
#### Defined in
[lib/types/Search.ts:2](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L2)
[lib/types/Search.ts:2](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L2)
___
@ -33,4 +33,4 @@ ___
#### Defined in
[lib/types/Search.ts:3](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Search.ts#L3)
[lib/types/Search.ts:3](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Search.ts#L3)

26
docs/api/interfaces/Show.md
View File

@ -28,7 +28,7 @@
#### Defined in
[lib/types/Show.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Show.ts#L8)
[lib/types/Show.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Show.ts#L8)
___
@ -38,7 +38,7 @@ ___
#### Defined in
[lib/types/Show.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Show.ts#L10)
[lib/types/Show.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Show.ts#L10)
___
@ -48,7 +48,7 @@ ___
#### Defined in
[lib/types/Show.ts:16](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Show.ts#L16)
[lib/types/Show.ts:16](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Show.ts#L16)
___
@ -58,7 +58,7 @@ ___
#### Defined in
[lib/types/Show.ts:18](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Show.ts#L18)
[lib/types/Show.ts:18](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Show.ts#L18)
___
@ -68,7 +68,7 @@ ___
#### Defined in
[lib/types/Show.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Show.ts#L5)
[lib/types/Show.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Show.ts#L5)
___
@ -78,7 +78,7 @@ ___
#### Defined in
[lib/types/Show.ts:7](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Show.ts#L7)
[lib/types/Show.ts:7](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Show.ts#L7)
___
@ -88,7 +88,7 @@ ___
#### Defined in
[lib/types/Show.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Show.ts#L19)
[lib/types/Show.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Show.ts#L19)
___
@ -98,7 +98,7 @@ ___
#### Defined in
[lib/types/Show.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Show.ts#L9)
[lib/types/Show.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Show.ts#L9)
___
@ -115,7 +115,7 @@ ___
#### Defined in
[lib/types/Show.ts:11](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Show.ts#L11)
[lib/types/Show.ts:11](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Show.ts#L11)
___
@ -125,7 +125,7 @@ ___
#### Defined in
[lib/types/Show.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Show.ts#L17)
[lib/types/Show.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Show.ts#L17)
___
@ -135,7 +135,7 @@ ___
#### Defined in
[lib/types/Show.ts:15](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Show.ts#L15)
[lib/types/Show.ts:15](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Show.ts#L15)
___
@ -145,7 +145,7 @@ ___
#### Defined in
[lib/types/Show.ts:4](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Show.ts#L4)
[lib/types/Show.ts:4](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Show.ts#L4)
___
@ -155,4 +155,4 @@ ___
#### Defined in
[lib/types/Show.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Show.ts#L6)
[lib/types/Show.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Show.ts#L6)

8
docs/api/interfaces/ShowAPIGetShowParams.md
View File

@ -19,7 +19,7 @@
#### Defined in
[lib/show/ShowAPI.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/show/ShowAPI.ts#L12)
[lib/show/ShowAPI.ts:11](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/show/ShowAPI.ts#L11)
___
@ -29,7 +29,7 @@ ___
#### Defined in
[lib/show/ShowAPI.ts:13](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/show/ShowAPI.ts#L13)
[lib/show/ShowAPI.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/show/ShowAPI.ts#L12)
___
@ -39,7 +39,7 @@ ___
#### Defined in
[lib/show/ShowAPI.ts:14](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/show/ShowAPI.ts#L14)
[lib/show/ShowAPI.ts:13](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/show/ShowAPI.ts#L13)
___
@ -49,4 +49,4 @@ ___
#### Defined in
[lib/show/ShowAPI.ts:11](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/show/ShowAPI.ts#L11)
[lib/show/ShowAPI.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/show/ShowAPI.ts#L10)

2
docs/api/interfaces/ShowAPIListParams.md
View File

@ -16,4 +16,4 @@
#### Defined in
[lib/show/ShowAPI.ts:18](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/show/ShowAPI.ts#L18)
[lib/show/ShowAPI.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/show/ShowAPI.ts#L17)

14
docs/api/interfaces/Tag.md
View File

@ -22,7 +22,7 @@
#### Defined in
[lib/types/Tag.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Tag.ts#L12)
[lib/types/Tag.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Tag.ts#L12)
___
@ -32,7 +32,7 @@ ___
#### Defined in
[lib/types/Tag.ts:11](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Tag.ts#L11)
[lib/types/Tag.ts:11](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Tag.ts#L11)
___
@ -42,7 +42,7 @@ ___
#### Defined in
[lib/types/Tag.ts:7](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Tag.ts#L7)
[lib/types/Tag.ts:7](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Tag.ts#L7)
___
@ -52,7 +52,7 @@ ___
#### Defined in
[lib/types/Tag.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Tag.ts#L10)
[lib/types/Tag.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Tag.ts#L10)
___
@ -62,7 +62,7 @@ ___
#### Defined in
[lib/types/Tag.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Tag.ts#L6)
[lib/types/Tag.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Tag.ts#L6)
___
@ -72,7 +72,7 @@ ___
#### Defined in
[lib/types/Tag.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Tag.ts#L8)
[lib/types/Tag.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Tag.ts#L8)
___
@ -82,4 +82,4 @@ ___
#### Defined in
[lib/types/Tag.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Tag.ts#L9)
[lib/types/Tag.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Tag.ts#L9)

4
docs/api/interfaces/TagAPIGetAlbumHighlightsParams.md
View File

@ -17,7 +17,7 @@
#### Defined in
[lib/tag/TagAPI.ts:15](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/tag/TagAPI.ts#L15)
[lib/tag/TagAPI.ts:15](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/tag/TagAPI.ts#L15)
___
@ -27,4 +27,4 @@ ___
#### Defined in
[lib/tag/TagAPI.ts:14](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/tag/TagAPI.ts#L14)
[lib/tag/TagAPI.ts:14](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/tag/TagAPI.ts#L14)

10
docs/api/interfaces/TagAPIGetReleasesParams.md
View File

@ -20,7 +20,7 @@
#### Defined in
[lib/tag/TagAPI.ts:22](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/tag/TagAPI.ts#L22)
[lib/tag/TagAPI.ts:22](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/tag/TagAPI.ts#L22)
___
@ -30,7 +30,7 @@ ___
#### Defined in
[lib/tag/TagAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/tag/TagAPI.ts#L20)
[lib/tag/TagAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/tag/TagAPI.ts#L20)
___
@ -40,7 +40,7 @@ ___
#### Defined in
[lib/tag/TagAPI.ts:23](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/tag/TagAPI.ts#L23)
[lib/tag/TagAPI.ts:23](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/tag/TagAPI.ts#L23)
___
@ -50,7 +50,7 @@ ___
#### Defined in
[lib/tag/TagAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/tag/TagAPI.ts#L19)
[lib/tag/TagAPI.ts:19](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/tag/TagAPI.ts#L19)
___
@ -60,4 +60,4 @@ ___
#### Defined in
[lib/tag/TagAPI.ts:21](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/tag/TagAPI.ts#L21)
[lib/tag/TagAPI.ts:21](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/tag/TagAPI.ts#L21)

4
docs/api/interfaces/TagList.md
View File

@ -17,7 +17,7 @@
#### Defined in
[lib/types/Tag.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Tag.ts#L17)
[lib/types/Tag.ts:17](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Tag.ts#L17)
___
@ -27,4 +27,4 @@ ___
#### Defined in
[lib/types/Tag.ts:16](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Tag.ts#L16)
[lib/types/Tag.ts:16](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Tag.ts#L16)

28
docs/api/interfaces/Track.md
View File

@ -35,7 +35,7 @@
#### Defined in
[lib/types/Track.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Track.ts#L9)
[lib/types/Track.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Track.ts#L9)
___
@ -49,7 +49,7 @@ ___
#### Defined in
[lib/types/MediaKind.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/MediaKind.ts#L10)
[lib/types/MediaKind.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/MediaKind.ts#L10)
___
@ -59,7 +59,7 @@ ___
#### Defined in
[lib/types/Track.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Track.ts#L6)
[lib/types/Track.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Track.ts#L6)
___
@ -73,7 +73,7 @@ ___
#### Defined in
[lib/types/MediaKind.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/MediaKind.ts#L8)
[lib/types/MediaKind.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/MediaKind.ts#L8)
___
@ -87,7 +87,7 @@ ___
#### Defined in
[lib/types/MediaKind.ts:11](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/MediaKind.ts#L11)
[lib/types/MediaKind.ts:11](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/MediaKind.ts#L11)
___
@ -101,7 +101,7 @@ ___
#### Defined in
[lib/types/MediaKind.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/MediaKind.ts#L6)
[lib/types/MediaKind.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/MediaKind.ts#L6)
___
@ -111,7 +111,7 @@ ___
#### Defined in
[lib/types/Track.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Track.ts#L10)
[lib/types/Track.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Track.ts#L10)
___
@ -125,7 +125,7 @@ ___
#### Defined in
[lib/types/MediaKind.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/MediaKind.ts#L12)
[lib/types/MediaKind.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/MediaKind.ts#L12)
___
@ -146,7 +146,7 @@ ___
#### Defined in
[lib/types/MediaKind.ts:13](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/MediaKind.ts#L13)
[lib/types/MediaKind.ts:13](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/MediaKind.ts#L13)
___
@ -160,7 +160,7 @@ ___
#### Defined in
[lib/types/MediaKind.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/MediaKind.ts#L9)
[lib/types/MediaKind.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/MediaKind.ts#L9)
___
@ -170,7 +170,7 @@ ___
#### Defined in
[lib/types/Track.ts:7](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Track.ts#L7)
[lib/types/Track.ts:7](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Track.ts#L7)
___
@ -180,7 +180,7 @@ ___
#### Defined in
[lib/types/Track.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Track.ts#L8)
[lib/types/Track.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Track.ts#L8)
___
@ -190,7 +190,7 @@ ___
#### Defined in
[lib/types/Track.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/Track.ts#L5)
[lib/types/Track.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/Track.ts#L5)
___
@ -204,4 +204,4 @@ ___
#### Defined in
[lib/types/MediaKind.ts:7](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/MediaKind.ts#L7)
[lib/types/MediaKind.ts:7](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/MediaKind.ts#L7)

8
docs/api/interfaces/TrackAPIGetInfoParams.md
View File

@ -19,7 +19,7 @@
#### Defined in
[lib/track/TrackAPI.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/track/TrackAPI.ts#L10)
[lib/track/TrackAPI.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/track/TrackAPI.ts#L9)
___
@ -29,7 +29,7 @@ ___
#### Defined in
[lib/track/TrackAPI.ts:11](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/track/TrackAPI.ts#L11)
[lib/track/TrackAPI.ts:10](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/track/TrackAPI.ts#L10)
___
@ -39,7 +39,7 @@ ___
#### Defined in
[lib/track/TrackAPI.ts:12](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/track/TrackAPI.ts#L12)
[lib/track/TrackAPI.ts:11](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/track/TrackAPI.ts#L11)
___
@ -49,4 +49,4 @@ ___
#### Defined in
[lib/track/TrackAPI.ts:9](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/track/TrackAPI.ts#L9)
[lib/track/TrackAPI.ts:8](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/track/TrackAPI.ts#L8)

10
docs/api/interfaces/UserKind.md
View File

@ -30,7 +30,7 @@
#### Defined in
[lib/types/UserKind.ts:3](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/UserKind.ts#L3)
[lib/types/UserKind.ts:3](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/UserKind.ts#L3)
___
@ -40,7 +40,7 @@ ___
#### Defined in
[lib/types/UserKind.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/UserKind.ts#L5)
[lib/types/UserKind.ts:5](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/UserKind.ts#L5)
___
@ -50,7 +50,7 @@ ___
#### Defined in
[lib/types/UserKind.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/UserKind.ts#L6)
[lib/types/UserKind.ts:6](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/UserKind.ts#L6)
___
@ -60,7 +60,7 @@ ___
#### Defined in
[lib/types/UserKind.ts:2](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/UserKind.ts#L2)
[lib/types/UserKind.ts:2](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/UserKind.ts#L2)
___
@ -70,4 +70,4 @@ ___
#### Defined in
[lib/types/UserKind.ts:4](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/types/UserKind.ts#L4)
[lib/types/UserKind.ts:4](https://github.com/patrickkfkan/bandcamp-fetch/blob/19ec315/src/lib/types/UserKind.ts#L4)

31
package-lock.json generated
View File

@ -1,22 +1,24 @@
{
"name": "bandcamp-fetch",
"version": "1.0.0-dev",
"version": "1.0.2",
"lockfileVersion": 2,
"requires": true,
"packages": {
"": {
"name": "bandcamp-fetch",
"version": "1.0.0-dev",
"version": "1.0.2",
"license": "MIT",
"dependencies": {
"bottleneck": "^2.19.5",
"cheerio": "^1.0.0-rc.5",
"cookie": "^0.5.0",
"eval5": "^1.4.7",
"html-entities": "^2.0.2",
"node-cache": "^5.1.2",
"node-fetch": "^2.6.9"
},
"devDependencies": {
"@types/cookie": "^0.5.3",
"@types/node": "^14.18.38",
"@types/node-fetch": "^2.6.4",
"@typescript-eslint/eslint-plugin": "^5.56.0",
@ -255,6 +257,12 @@
"@types/estree": "*"
}
},
"node_modules/@types/cookie": {
"version": "0.5.3",
"resolved": "https://registry.npmjs.org/@types/cookie/-/cookie-0.5.3.tgz",
"integrity": "sha512-SLg07AS9z1Ab2LU+QxzU8RCmzsja80ywjf/t5oqw+4NSH20gIGlhLOrBDm1L3PBWzPa4+wkgFQVZAjE6Ioj2ug==",
"dev": true
},
"node_modules/@types/estree": {
"version": "0.0.41",
"resolved": "https://registry.npmjs.org/@types/estree/-/estree-0.0.41.tgz",
@ -765,6 +773,14 @@
"integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==",
"dev": true
},
"node_modules/cookie": {
"version": "0.5.0",
"resolved": "https://registry.npmjs.org/cookie/-/cookie-0.5.0.tgz",
"integrity": "sha512-YZ3GUyn/o8gfKJlnlX7g7xq4gyO6OSuhGPKaaGssGB2qgDUS0gPgtTvoyZLTt9Ab6dC4hfc9dV5arkvc/OCmrw==",
"engines": {
"node": ">= 0.6"
}
},
"node_modules/create-require": {
"version": "1.1.1",
"resolved": "https://registry.npmjs.org/create-require/-/create-require-1.1.1.tgz",
@ -2619,6 +2635,12 @@
"@types/estree": "*"
}
},
"@types/cookie": {
"version": "0.5.3",
"resolved": "https://registry.npmjs.org/@types/cookie/-/cookie-0.5.3.tgz",
"integrity": "sha512-SLg07AS9z1Ab2LU+QxzU8RCmzsja80ywjf/t5oqw+4NSH20gIGlhLOrBDm1L3PBWzPa4+wkgFQVZAjE6Ioj2ug==",
"dev": true
},
"@types/estree": {
"version": "0.0.41",
"resolved": "https://registry.npmjs.org/@types/estree/-/estree-0.0.41.tgz",
@ -2971,6 +2993,11 @@
"integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==",
"dev": true
},
"cookie": {
"version": "0.5.0",
"resolved": "https://registry.npmjs.org/cookie/-/cookie-0.5.0.tgz",
"integrity": "sha512-YZ3GUyn/o8gfKJlnlX7g7xq4gyO6OSuhGPKaaGssGB2qgDUS0gPgtTvoyZLTt9Ab6dC4hfc9dV5arkvc/OCmrw=="
},
"create-require": {
"version": "1.1.1",
"resolved": "https://registry.npmjs.org/create-require/-/create-require-1.1.1.tgz",

2
package.json
View File

@ -39,6 +39,7 @@
"node": ">=14"
},
"devDependencies": {
"@types/cookie": "^0.5.3",
"@types/node": "^14.18.38",
"@types/node-fetch": "^2.6.4",
"@typescript-eslint/eslint-plugin": "^5.56.0",
@ -54,6 +55,7 @@
"dependencies": {
"bottleneck": "^2.19.5",
"cheerio": "^1.0.0-rc.5",
"cookie": "^0.5.0",
"eval5": "^1.4.7",
"html-entities": "^2.0.2",
"node-cache": "^5.1.2",

69
src/index.ts
View File

@ -1,17 +1,7 @@
import AlbumAPI, { LimiterAlbumAPI } from './lib/album/AlbumAPI';
import ArticleAPI, { LimiterArticleAPI } from './lib/article/ArticleAPI';
import BandAPI, { LimiterBandAPI } from './lib/band/BandAPI';
import DiscoveryAPI, { LimiterDiscoveryAPI } from './lib/discovery/DiscoveryAPI';
import FanAPI, { LimiterFanAPI } from './lib/fan/FanAPI';
import ImageAPI, { LimiterImageAPI } from './lib/image/ImageAPI';
import ShowAPI, { LimiterShowAPI } from './lib/show/ShowAPI';
import TagAPI, { LimiterTagAPI } from './lib/tag/TagAPI';
import TrackAPI, { LimiterTrackAPI } from './lib/track/TrackAPI';
import SearchAPI, { LimiterSearchAPI } from './lib/search/SearchAPI';
import AutocompleteAPI, { LimiterAutocompleteAPI } from './lib/autocomplete/AutocompleteAPI';
import Limiter from './lib/utils/Limiter';
import { CacheDataType, Cache as CacheImpl } from './lib/utils/Cache';
import BandcampFetch from './lib/BandcampFetch';
export { default as BaseAPI } from './lib/common/BaseAPI';
export { default as BaseAPIWithImageSupport } from './lib/common/BaseAPIWithImageSupport';
export { default as AlbumAPI } from './lib/album/AlbumAPI';
export { default as ArticleAPI } from './lib/article/ArticleAPI';
export { default as BandAPI } from './lib/band/BandAPI';
@ -24,6 +14,8 @@ export { default as TrackAPI } from './lib/track/TrackAPI';
export { default as SearchAPI } from './lib/search/SearchAPI';
export { default as AutocompleteAPI } from './lib/autocomplete/AutocompleteAPI';
export * from './lib/common/BaseAPI';
export * from './lib/common/BaseAPIWithImageSupport';
export * from './lib/album/AlbumAPI';
export * from './lib/discovery/DiscoveryAPI';
export * from './lib/image/ImageAPI';
@ -51,7 +43,12 @@ export * from './lib/types/Track';
export * from './lib/types/UserKind';
export * from './lib/types/Search';
export * from './lib/types/Autocomplete';
export { CacheDataType } from './lib/utils/Cache';
export { default as Cache } from './lib/utils/Cache';
export * from './lib/utils/Cache';
export { default as Fetcher } from './lib/utils/Fetcher';
export * from './lib/utils/Fetcher';
export { default as Limiter } from './lib/utils/Limiter';
export { default as Album } from './lib/types/Album';
export { default as Article } from './lib/types/Article';
@ -65,45 +62,7 @@ export { default as Track } from './lib/types/Track';
export { default as UserKind } from './lib/types/UserKind';
export { default as NameValuePair } from './lib/utils/NameValuePair';
export class Cache {
static clear(type?: CacheDataType) {
CacheImpl.clear(type);
}
export { default as BandcampFetch } from './lib/BandcampFetch';
export * from './lib/BandcampFetch';
static setTTL(type: CacheDataType, ttl: number) {
CacheImpl.setTTL(type, ttl);
}
static setMaxPages(maxPages: number) {
CacheImpl.setMaxEntries(CacheDataType.Page, maxPages);
}
}
export default {
album: AlbumAPI,
track: TrackAPI,
discovery: DiscoveryAPI,
image: ImageAPI,
band: BandAPI,
tag: TagAPI,
article: ArticleAPI,
show: ShowAPI,
fan: FanAPI,
search: SearchAPI,
autocomplete: AutocompleteAPI,
limiter: {
album: LimiterAlbumAPI,
track: LimiterTrackAPI,
discovery: LimiterDiscoveryAPI,
image: LimiterImageAPI,
band: LimiterBandAPI,
tag: LimiterTagAPI,
article: LimiterArticleAPI,
show: LimiterShowAPI,
fan: LimiterFanAPI,
search: LimiterSearchAPI,
autocomplete: LimiterAutocompleteAPI,
updateSettings: Limiter.updateSettings.bind(Limiter)
},
cache: Cache
};
export default new BandcampFetch();

142
src/lib/BandcampFetch.ts Normal file
View File

@ -0,0 +1,142 @@
import Bottleneck from 'bottleneck';
import AlbumAPI, { LimiterAlbumAPI } from './album/AlbumAPI';
import ArticleAPI, { LimiterArticleAPI } from './article/ArticleAPI';
import AutocompleteAPI, { LimiterAutocompleteAPI } from './autocomplete/AutocompleteAPI';
import BandAPI, { LimiterBandAPI } from './band/BandAPI';
import DiscoveryAPI, { LimiterDiscoveryAPI } from './discovery/DiscoveryAPI';
import FanAPI, { LimiterFanAPI } from './fan/FanAPI';
import ImageAPI, { LimiterImageAPI } from './image/ImageAPI';
import SearchAPI, { LimiterSearchAPI } from './search/SearchAPI';
import ShowAPI, { LimiterShowAPI } from './show/ShowAPI';
import TagAPI, { LimiterTagAPI } from './tag/TagAPI';
import TrackAPI, { LimiterTrackAPI } from './track/TrackAPI';
import Cache, { CacheDataType } from './utils/Cache';
import Fetcher from './utils/Fetcher';
import Limiter from './utils/Limiter';
export interface BandcampFetchParams {
cookie?: string | null;
}
export default class BandcampFetch {
#cookie?: string | null;
#fetcher: Fetcher;
#cache: Cache;
#wrappedCache: CacheWrapper;
#limiter: Limiter;
readonly album: AlbumAPI;
readonly track: TrackAPI;
readonly discovery: DiscoveryAPI;
readonly image: ImageAPI;
readonly band: BandAPI;
readonly tag: TagAPI;
readonly article: ArticleAPI;
readonly show: ShowAPI;
readonly fan: FanAPI;
readonly search: SearchAPI;
readonly autocomplete: AutocompleteAPI;
readonly limiter: {
readonly album: LimiterAlbumAPI;
readonly track: LimiterTrackAPI;
readonly discovery: LimiterDiscoveryAPI;
readonly image: LimiterImageAPI;
readonly band: LimiterBandAPI;
readonly tag: LimiterTagAPI;
readonly article: LimiterArticleAPI;
readonly show: LimiterShowAPI;
readonly fan: LimiterFanAPI;
readonly search: LimiterSearchAPI;
readonly autocomplete: LimiterAutocompleteAPI;
updateSettings: (options?: Bottleneck.ConstructorOptions) => void;
};
constructor(params?: BandcampFetchParams) {
this.#cookie = params?.cookie;
this.#cache = new Cache({
[CacheDataType.Constants]: 3600,
[CacheDataType.Page]: 300
}, { page: 10 });
this.#wrappedCache = new CacheWrapper(this.#cache);
this.#fetcher = new Fetcher({
cookie: this.#cookie,
cache: this.#cache
});
this.#limiter = new Limiter();
const baseAPIParams = {
fetcher: this.#fetcher,
cache: this.#cache,
limiter: this.#limiter
};
this.image = new ImageAPI(baseAPIParams);
const baseAPIWithImageSupportParams = {
...baseAPIParams,
imageAPI: this.image
};
this.album = new AlbumAPI(baseAPIWithImageSupportParams);
this.track = new TrackAPI(baseAPIWithImageSupportParams);
this.discovery = new DiscoveryAPI(baseAPIWithImageSupportParams);
this.image = new ImageAPI(baseAPIParams);
this.band = new BandAPI(baseAPIWithImageSupportParams);
this.tag = new TagAPI(baseAPIWithImageSupportParams);
this.article = new ArticleAPI(baseAPIWithImageSupportParams);
this.show = new ShowAPI(baseAPIWithImageSupportParams);
this.fan = new FanAPI(baseAPIWithImageSupportParams);
this.search = new SearchAPI(baseAPIWithImageSupportParams);
this.autocomplete = new AutocompleteAPI(baseAPIParams);
this.limiter = {
album: new LimiterAlbumAPI(baseAPIWithImageSupportParams),
track: new LimiterTrackAPI(baseAPIWithImageSupportParams),
discovery: new LimiterDiscoveryAPI(baseAPIWithImageSupportParams),
image: new LimiterImageAPI(baseAPIParams),
band: new LimiterBandAPI(baseAPIWithImageSupportParams),
tag: new LimiterTagAPI(baseAPIWithImageSupportParams),
article: new LimiterArticleAPI(baseAPIWithImageSupportParams),
show: new LimiterShowAPI(baseAPIWithImageSupportParams),
fan: new LimiterFanAPI(baseAPIWithImageSupportParams),
search: new LimiterSearchAPI(baseAPIWithImageSupportParams),
autocomplete: new LimiterAutocompleteAPI(baseAPIParams),
updateSettings: this.#limiter.updateSettings.bind(this.#limiter)
};
}
setCookie(value?: string | null) {
this.#cookie = value;
this.#fetcher.setCookie(value);
}
get cookie() {
return this.#cookie;
}
get cache() {
return this.#wrappedCache;
}
}
export class CacheWrapper {
#cache: Cache;
constructor(cache: Cache) {
this.#cache = cache;
}
clear(type?: CacheDataType) {
this.#cache.clear(type);
}
setTTL(type: CacheDataType, ttl: number) {
this.#cache.setTTL(type, ttl);
}
setMaxPages(maxPages: number) {
this.#cache.setMaxEntries(CacheDataType.Page, maxPages);
}
}

Some files were not shown because too many files have changed in this diff Show More