Skip to content

Commit

Permalink
chore(web): add better comments to settings store
Browse files Browse the repository at this point in the history
Signed-off-by: Jordan Shatford <[email protected]>
  • Loading branch information
jordanshatford committed Dec 23, 2024
1 parent d85ae04 commit 740b4d1
Showing 1 changed file with 28 additions and 5 deletions.
33 changes: 28 additions & 5 deletions apps/web/src/stores/settings.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,42 @@ import { ClipProvider } from '@cq/providers'

import { Command } from '@/utils/commands'

/**
* Settings for commands.
*/
export interface CommandSettings {
// Prefix for chat commands.
/**
* The prefix for commands.
*
* @example !cq
*/
prefix: string
// Commands allowed to be used in chat.
/**
* The commands allowed to be used.
*/
allowed: Command[]
}

/**
* Settings for the queue.
*/
export interface QueueSettings {
// Auto remove clips when the submitter has there message deleted, or is timed out / banned.
/**
* Whether auto moderation is enabled.
*
* @note This will remove clips when the submitter has their message deleted, or is timed out / banned.
*/
hasAutoModerationEnabled: boolean
// Limit of clips allowed in queue at one time.
/**
* The limit of clips in the queue.
*
* @example 10
* @note null means no limit.
*/
limit: number | null
// Allowed clip providers (Kick, Twitch, Etc.)
/**
* The providers allowed to be used for clips.
*/
providers: ClipProvider[]
}

Expand Down

0 comments on commit 740b4d1

Please sign in to comment.