bandcamp-fetch/docs/api/classes/ImageAPI.md

68 lines
1.3 KiB
Markdown
Raw Normal View History

2023-06-10 16:52:27 +02:00
[bandcamp-fetch](../README.md) / ImageAPI
# Class: ImageAPI
## Hierarchy
- **`ImageAPI`**
↳ [`LimiterImageAPI`](LimiterImageAPI.md)
## Table of contents
### Constructors
- [constructor](ImageAPI.md#constructor)
### Methods
- [getFormat](ImageAPI.md#getformat)
- [getFormats](ImageAPI.md#getformats)
## Constructors
### constructor
**new ImageAPI**()
## Methods
### getFormat
`Static` **getFormat**(`target?`, `fallbackId?`): `Promise`<``null`` \| [`ImageFormat`](../interfaces/ImageFormat.md)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `target?` | `string` \| `number` \| [`ImageFormat`](../interfaces/ImageFormat.md) |
| `fallbackId?` | `number` |
#### Returns
`Promise`<``null`` \| [`ImageFormat`](../interfaces/ImageFormat.md)\>
#### Defined in
2023-06-13 22:09:54 +02:00
[lib/image/ImageAPI.ts:27](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/image/ImageAPI.ts#L27)
2023-06-10 16:52:27 +02:00
___
### getFormats
`Static` **getFormats**(`filter?`): `Promise`<[`ImageFormat`](../interfaces/ImageFormat.md)[]\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `filter?` | [`ImageFormatFilter`](../enums/ImageFormatFilter.md) |
#### Returns
`Promise`<[`ImageFormat`](../interfaces/ImageFormat.md)[]\>
#### Defined in
2023-06-13 22:09:54 +02:00
[lib/image/ImageAPI.ts:47](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/image/ImageAPI.ts#L47)