agendash/dist/middlewares/koa.d.ts

Dashboard for Agenda job scheduler

import type { Agenda } from 'agenda';
import type { Middleware } from 'koa';
/**
 * Create Koa middleware array for Agendash (sync version)
 * Note: This returns only the CSP middleware. Use createKoaMiddlewareAsync for full setup.
 *
 * @deprecated Use createKoaMiddlewareAsync instead for complete middleware setup
 * @example
 * ```typescript
 * import Koa from 'koa';
 * import { Agenda } from 'agenda';
 * import { createKoaMiddlewareAsync } from 'agendash';
 *
 * const app = new Koa();
 * const agenda = new Agenda({ db: { address: 'mongodb://localhost/agenda' } });
 *
 * const middlewares = await createKoaMiddlewareAsync(agenda);
 * middlewares.forEach(mw => app.use(mw));
 * ```
 */
export declare function createKoaMiddleware(_agenda: Agenda): Middleware[];
/**
 * Async version that fully sets up all middlewares
 */
export declare function createKoaMiddlewareAsync(agenda: Agenda): Promise<Middleware[]>;