mirror of
https://github.com/LukeHagar/Prowlarr-TS-SDK.git
synced 2025-12-06 04:21:03 +00:00
31 lines
4.1 KiB
Markdown
31 lines
4.1 KiB
Markdown
# Field
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import { Field } from "prowlarr";
|
|
|
|
let value: Field = {};
|
|
```
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description |
|
|
| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
|
|
| `order` | *number* | :heavy_minus_sign: | N/A |
|
|
| `name` | *string* | :heavy_minus_sign: | N/A |
|
|
| `label` | *string* | :heavy_minus_sign: | N/A |
|
|
| `unit` | *string* | :heavy_minus_sign: | N/A |
|
|
| `helpText` | *string* | :heavy_minus_sign: | N/A |
|
|
| `helpTextWarning` | *string* | :heavy_minus_sign: | N/A |
|
|
| `helpLink` | *string* | :heavy_minus_sign: | N/A |
|
|
| `value` | *any* | :heavy_minus_sign: | N/A |
|
|
| `type` | *string* | :heavy_minus_sign: | N/A |
|
|
| `advanced` | *boolean* | :heavy_minus_sign: | N/A |
|
|
| `selectOptions` | [models.SelectOption](../models/selectoption.md)[] | :heavy_minus_sign: | N/A |
|
|
| `selectOptionsProviderAction` | *string* | :heavy_minus_sign: | N/A |
|
|
| `section` | *string* | :heavy_minus_sign: | N/A |
|
|
| `hidden` | *string* | :heavy_minus_sign: | N/A |
|
|
| `privacy` | [models.PrivacyLevel](../models/privacylevel.md) | :heavy_minus_sign: | N/A |
|
|
| `placeholder` | *string* | :heavy_minus_sign: | N/A |
|
|
| `isFloat` | *boolean* | :heavy_minus_sign: | N/A | |