mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 04:20:46 +00:00
25 lines
3.6 KiB
Markdown
25 lines
3.6 KiB
Markdown
# ButlerTask
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import { ButlerTask } from "@lukehagar/plexjs";
|
|
|
|
let value: ButlerTask = {
|
|
name: "BackupDatabase",
|
|
interval: 3,
|
|
title: "Backup Database",
|
|
description: "Create a backup copy of the server's database in the configured backup directory",
|
|
};
|
|
```
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
|
| `name` | *string* | :heavy_minus_sign: | N/A | BackupDatabase |
|
|
| `interval` | *number* | :heavy_minus_sign: | N/A | 3 |
|
|
| `scheduleRandomized` | *boolean* | :heavy_minus_sign: | N/A | |
|
|
| `enabled` | *boolean* | :heavy_minus_sign: | N/A | |
|
|
| `title` | *string* | :heavy_minus_sign: | N/A | Backup Database |
|
|
| `description` | *string* | :heavy_minus_sign: | N/A | Create a backup copy of the server's database in the configured backup directory | |