fix(docs): Fix JSDoc syntax for createSchedule parameter documentation

TypeScript JSDoc doesn't support nested @param tags.
Changed from @param schedule.id to inline description in @param schedule.

Verification:
- TypeScript compiles 
This commit is contained in:
Matthew Raymer
2025-12-23 07:23:25 +00:00
parent bdd2a5d7ac
commit d596346ba2

View File

@@ -609,14 +609,14 @@ export interface DailyNotificationPlugin {
/**
* Create a new recurring schedule
*
* @param schedule Schedule configuration
* @param schedule.id - Unique schedule identifier (required, must be unique)
* @param schedule.kind - Schedule type: 'notify' for notifications, 'fetch' for content fetching
* @param schedule.cron - Cron expression (e.g., '0 9 * * *' for daily at 9 AM). Mutually exclusive with clockTime
* @param schedule.clockTime - Time of day in HH:mm format (e.g., '09:00'). Mutually exclusive with cron
* @param schedule.enabled - Whether schedule is active (default: true)
* @param schedule.jitterMs - Random jitter in milliseconds (default: 0)
* @param schedule.backoffPolicy - Backoff policy for retries (default: 'exp')
* @param schedule Schedule configuration object with:
* - `id` (required): Unique schedule identifier (must be unique)
* - `kind`: Schedule type: 'notify' for notifications, 'fetch' for content fetching
* - `cron`: Cron expression (e.g., '0 9 * * *' for daily at 9 AM). Mutually exclusive with clockTime
* - `clockTime`: Time of day in HH:mm format (e.g., '09:00'). Mutually exclusive with cron
* - `enabled`: Whether schedule is active (default: true)
* - `jitterMs`: Random jitter in milliseconds (default: 0)
* - `backoffPolicy`: Backoff policy for retries (default: 'exp')
* @returns Promise resolving to created Schedule object
* @throws {DailyNotificationError} If schedule creation fails (e.g., invalid cron, duplicate ID, permission denied)
*