Function: describeReportSchedule()
function describeReportSchedule(config:
| {
cadence: "daily";
format: "pdf" | "csv" | "xlsx";
recipients: string[];
timeOfDay: string;
timezone: string;
}
| {
cadence: "weekly";
format: "pdf" | "csv" | "xlsx";
recipients: string[];
timeOfDay: string;
timezone: string;
weekdays: number[];
}
| {
cadence: "monthly";
dayOfMonth: number | "last";
format: "pdf" | "csv" | "xlsx";
recipients: string[];
timeOfDay: string;
timezone: string;
}
| {
cadence: "custom";
cron: string;
format: "pdf" | "csv" | "xlsx";
recipients: string[];
timezone: string;
}): string;Defined in: shared/insights/schedule.ts:324
A one-line, human-readable summary of when a schedule fires — e.g.
"Weekly on Mon, Wed at 9:00 AM (America/New_York)". Used by the dialog's
live preview and any list rendering, so the phrasing lives with the schema it
describes rather than being re-derived in the client.
Parameters
| Parameter | Type |
|---|---|
config | | { cadence: "daily"; format: "pdf" | "csv" | "xlsx"; recipients: string[]; timeOfDay: string; timezone: string; } | { cadence: "weekly"; format: "pdf" | "csv" | "xlsx"; recipients: string[]; timeOfDay: string; timezone: string; weekdays: number[]; } | { cadence: "monthly"; dayOfMonth: number | "last"; format: "pdf" | "csv" | "xlsx"; recipients: string[]; timeOfDay: string; timezone: string; } | { cadence: "custom"; cron: string; format: "pdf" | "csv" | "xlsx"; recipients: string[]; timezone: string; } |
Returns
string