@5minds/processcube_engine
Version:
The ProcessCube Engine. Stores and executes BPMNs.
17 lines (16 loc) • 748 B
TypeScript
import { MiddlewareFunction } from './MiddlewareFunction';
/**
* Allows you to mark a route as deprecated.
*
* Usage:
*
* Without an alternative route:
* router.post('/my/depcreated/route', deprecate(), requestHandlerFunction);
*
* With an alternative route:
* router.post('/my/depcreated/route', deprecate('/my/alternative/route'), requestHandlerFunction);
*
* @param deprecateSilently Optional: If true, no log message will be printed to the console. This can be useful for routes with high traffic to prevent a log spam.
* @param alternativeRoute Optional: A replacement route that the user can use as an alternative.
*/
export declare function deprecate(deprecateSilently?: boolean, alternativeRoute?: string): MiddlewareFunction;