@kentcdodds/kit

Kit.com helpers for subscribers, tags, forms, sequences, and broadcasts.

src/list-broadcasts.d.ts

23 lines · 599 B · TypeScript

export type BroadcastSummary = {
	id: number
	subject?: string
	status?: string
	editUrl: string
}

export type ListBroadcastsInput = {
	status?: string
	per_page?: number
	/** Cap pagination — omit only when you intentionally want the full history. */
	maxItems?: number
}

/**
 * List broadcast summaries. Always pass `maxItems` for exploratory reads.
 * @example
 * import listBroadcasts from 'kody:@kentcdodds/kit/list-broadcasts'
 * const recent = await listBroadcasts({ maxItems: 10 })
 */
export default function listBroadcasts(
	query?: ListBroadcastsInput,
): Promise<BroadcastSummary[]>