---
description: All the custom types used in the package.
---

# Types

### Sort

Type: [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)

<details>

<summary>Available Values</summary>

* newest
* rating

</details>

### Operator

Type: [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)

<details>

<summary>Available Values</summary>

* min
* max
* equal

</details>

### DeviceType

Type: [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)

<details>

<summary>Available Values</summary>

* desktop
* phone

</details>

### URL

|   PARAMETER   |                                                TYPE                                               |                   DESCRIPTION                  |
| :-----------: | :-----------------------------------------------------------------------------------------------: | :--------------------------------------------: |
|   **image**   | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) |               Link to the image.               |
| **thumbnail** | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) |   Link to the thumbnail version of the image.  |
|  **webpage**  | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | A link to the webpage where the image is held. |

### BySortOptions

<table><thead><tr><th width="150" align="center">PARAMETER</th><th width="180.34017915665282" align="center">TYPE</th><th width="150" align="center">DEFAULTS TO</th><th width="254.15384615384616" align="center">DESCRIPTION</th></tr></thead><tbody><tr><td align="center"><strong>height</strong></td><td align="center"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a></td><td align="center">N/A</td><td align="center">Height of a wallpaper.</td></tr><tr><td align="center"><strong>operator</strong></td><td align="center"><a href="#operator">Operator</a></td><td align="center">equal</td><td align="center">Filter out with respect to the Height and Width.</td></tr><tr><td align="center"><strong>page</strong></td><td align="center"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a></td><td align="center">1</td><td align="center">Different sets of results.</td></tr><tr><td align="center"><strong>ratio</strong></td><td align="center">[<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a>]</td><td align="center">N/A</td><td align="center"><p>[Min, Max] ratios of the wallpaper size.</p><p>Applicable only to 'phone' type.</p></td></tr><tr><td align="center"><strong>type</strong></td><td align="center"><a href="#devicetype">DeviceType</a></td><td align="center">desktop</td><td align="center">Type of the device.</td></tr><tr><td align="center"><strong>width</strong></td><td align="center"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a></td><td align="center">N/A</td><td align="center">Width of a wallpaper.</td></tr></tbody></table>

### Wallpaper

<table><thead><tr><th width="150" align="center">PARAMETER</th><th width="150" align="center">TYPE</th><th width="150" align="center">DEFAULTS TO</th><th width="257.1538461538462" align="center">DESCRIPTION</th></tr></thead><tbody><tr><td align="center"><strong>level</strong></td><td align="center"><a href="#level">level</a></td><td align="center">1</td><td align="center">The quantity of info returned for each wallpaper.</td></tr><tr><td align="center"><strong>sort</strong></td><td align="center"><a href="#sort">sort</a></td><td align="center">newest</td><td align="center">How are the wallpapers sorted.</td></tr><tr><td align="center"><strong>page</strong></td><td align="center"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a></td><td align="center">1</td><td align="center">Page number, there are 30 wallpapers per page.</td></tr><tr><td align="center"><strong>width</strong></td><td align="center"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a></td><td align="center">N/A</td><td align="center">Width of the wallpaper.</td></tr><tr><td align="center"><strong>height</strong></td><td align="center"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a></td><td align="center">N/A</td><td align="center">Height of the wallpaper.</td></tr><tr><td align="center"><strong>operator</strong></td><td align="center"><a href="#operator">operator</a></td><td align="center">equal</td><td align="center">The type of resolution filter.</td></tr></tbody></table>

### List

|      PARAMETER     |                                                                                                                                           TYPE                                                                                                                                           |              DESCRIPTION              |
| :----------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------: |
|       **id**       |                                                                                             [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)                                                                                            |  ID of the Category or Sub-Category.  |
|      **name**      |                                                                                             [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)                                                                                            | Name of the Category or Sub-Category. |
| **wallpaperCount** | <p><strong>desktop</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a></p><p><strong>phone</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a></p> |   Number of wallpapers in each type.  |

### WallpaperInfo

|   PARAMETER   |                                                        TYPE                                                        |           DESCRIPTION           |
| :-----------: | :----------------------------------------------------------------------------------------------------------------: | :-----------------------------: |
| **wallpaper** |                                                      Wallpaper                                                     |            Refer type           |
|    **tag**    | [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[NameID](#nameid)> | Tags attached to the wallpaper. |

### QueryCount

|    PARAMETER    |                                                TYPE                                               |          DESCRIPTION          |
| :-------------: | :-----------------------------------------------------------------------------------------------: | :---------------------------: |
| **percentUsed** | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Percentage of API calls used. |
|     **used**    | [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) |   Number of used API calls.   |
|    **unused**   | [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) |  Number of unused API calls.  |

### File

| PARAMETER |                                                         TYPE                                                        |             DESCRIPTION            |
| :-------: | :-----------------------------------------------------------------------------------------------------------------: | :--------------------------------: |
|  **size** |          [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)          | Size of the file in MegaBytes (MB) |
|  **type** | 'jpg' \| 'png' \| [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) |          Type of the file.         |

### NameID

| PARAMETER |                                                TYPE                                               |          DESCRIPTION          |
| :-------: | :-----------------------------------------------------------------------------------------------: | :---------------------------: |
|   **id**  | [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) |  ID of the preceding object.  |
|  **name** | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Name of the preceding object. |

### GetWallpaperOptions

<table><thead><tr><th width="182" align="center">PARAMETER</th><th width="174" align="center">TYPE</th><th width="150" align="center">DEFAULTS TO</th><th align="center">DESCRIPTION</th></tr></thead><tbody><tr><td align="center"><strong>height</strong></td><td align="center"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a></td><td align="center">N/A</td><td align="center">Height of the wallpaper.</td></tr><tr><td align="center"><strong>operator</strong></td><td align="center"><a href="#operator">Operator</a></td><td align="center">equal</td><td align="center">Filter out with respect to height and width.</td></tr><tr><td align="center"><strong>page</strong></td><td align="center"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a></td><td align="center">1</td><td align="center">Different sets of results.</td></tr><tr><td align="center"><strong>ratio</strong></td><td align="center">[<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a>]</td><td align="center">N/A</td><td align="center">[Min, Max] ratios of the wallpaper size. Applicable only to 'phone' type.</td></tr><tr><td align="center"><strong>sort</strong></td><td align="center"><a href="#sort">Sort</a></td><td align="center">N/A</td><td align="center"> A sorting method.</td></tr><tr><td align="center"><strong>type</strong></td><td align="center"><a href="#devicetype">DeviceType</a></td><td align="center">desktop</td><td align="center">Type of the device.</td></tr><tr><td align="center"><strong>width</strong></td><td align="center"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a></td><td align="center">N/A</td><td align="center">Width of the wallpaper.</td></tr></tbody></table>

