bandcamp-fetch/docs/api/interfaces/DiscoverResult.md

50 lines
997 B
Markdown
Raw Permalink Normal View History

2023-06-10 16:52:27 +02:00
[bandcamp-fetch](../README.md) / DiscoverResult
# Interface: DiscoverResult
Results returned by [discover](../classes/DiscoveryAPI.md#discover).
## Table of contents
### Properties
- [items](DiscoverResult.md#items)
- [params](DiscoverResult.md#params)
- [total](DiscoverResult.md#total)
## Properties
### items
**items**: [`Album`](Album.md)[]
List of discovered albums.
#### Defined in
2023-10-29 18:25:17 +01:00
[lib/types/Discovery.ts:51](https://github.com/patrickkfkan/bandcamp-fetch/blob/7bb1899/src/lib/types/Discovery.ts#L51)
2023-06-10 16:52:27 +02:00
___
### params
**params**: [`DiscoverParams`](DiscoverParams.md)
Sanitized params used in the discovery request.
#### Defined in
2023-10-29 18:25:17 +01:00
[lib/types/Discovery.ts:59](https://github.com/patrickkfkan/bandcamp-fetch/blob/7bb1899/src/lib/types/Discovery.ts#L59)
2023-06-10 16:52:27 +02:00
___
### total
**total**: `number`
Total number of albums discovered.
#### Defined in
2023-10-29 18:25:17 +01:00
[lib/types/Discovery.ts:55](https://github.com/patrickkfkan/bandcamp-fetch/blob/7bb1899/src/lib/types/Discovery.ts#L55)