agendash/dist/middlewares/express.d.ts

Dashboard for Agenda job scheduler

import { Router } from 'express';
import type { Agenda } from 'agenda';
export interface ExpressMiddlewareOptions {
    /** Skip static file serving (useful for dev mode with Vite) */
    skipStaticFiles?: boolean;
}
/**
 * Create Express middleware for Agendash
 *
 * @example
 * ```typescript
 * import express from 'express';
 * import { Agenda } from 'agenda';
 * import { createExpressMiddleware } from 'agendash';
 *
 * const app = express();
 * const agenda = new Agenda({ db: { address: 'mongodb://localhost/agenda' } });
 *
 * app.use('/dash', createExpressMiddleware(agenda));
 * ```
 */
export declare function createExpressMiddleware(agenda: Agenda, options?: ExpressMiddlewareOptions): Router;