middleware

Generated reference page for the middleware function export.

• Import: @kjanat/dreamcli
• Export kind: function
• Declared in: src/core/schema/middleware.ts
• Source link: packages/dreamcli/src/core/schema/middleware.ts:150

Signatures

function middleware<Output extends Record<string, unknown>>(handler: MiddlewareHandler<Output>): Middleware<Output>;

Parameter	Type	Description
handler	MiddlewareHandler<Output>	Function receiving { args, flags, ctx, out, meta, next }. Call next(additions) to continue the chain with added context. Omitting the next() call short-circuits (e.g., for auth guards).

Members

Members

middleware

Create a middleware definition.

Middleware runs before the action handler and can add typed context, short-circuit execution, or wrap downstream processing.

(handler: MiddlewareHandler<Output>): Middleware<Output>;

Examples

// Auth guard — adds user to context or throws
const auth = middleware(async ({ next }) => {
  const user = await getUser();
  if (!user) throw new CLIError('Not authenticated', { code: 'AUTH_REQUIRED' });
  return next({ user });
});

// Timing wrapper — measures downstream execution
const timing = middleware(async ({ out, next }) => {
  const start = Date.now();
  await next({});
  out.info(`Done in ${Date.now() - start}ms`);
});

command('deploy')
  .middleware(timing)
  .middleware(auth)
  .action(({ ctx }) => {
    console.log(ctx.user.name); // typed!
  });

Related Examples

• Middleware patterns: auth guard, request timing, error handling. - examples/standalone/middleware.ts
• Testing examples using @kjanat/dreamcli/testkit. - examples/standalone/testing.ts

See Also

• Examples overview
• Example Hover
• API overview
• @kjanat/dreamcli