route-blocker
TypeScript icon, indicating that this package has built-in type declarations

1.2.1 • Public • Published

route-blocker · GitHub license npm version Test and Build Status Issues Downloads

A middleware for expressjs to block or unblock a route

Install

Using npm

npm install route-blocker

Using yarn

yarn add route-blocker

Usage

In server.ts (or the file where app and routes are defined)

import { routeBlocker } from "route-blocker";
 
const BASE_ROUTE = "api/some-base-route";
export const subRouteToBlock = "some-sub-route";
const myRoute = `${BASE_ROUTE}/${subRouteToBlock}`;
 
app.use(myRoute, routeBlocker.middleware(subRouteToBlock));
app.get(myRoute, myRouteFunction);

In the file where the route blocking should be enabled/disabled

import { routeBlocker } from "route-blocker";
import { subRouteToBlock } from "src/server.ts";
 
routeBlocker.disableRoute(subRouteToBlock); // disable route
 
// do something
 
routeBlocker.enableRoute(subRouteToBlock); // enable route
 

To remove all route blockings

routeBlocker.clearBlockings();

Note

See the source for more details

package bundle size express release pull request

License

route-blocker is MIT licensed.

Package Sidebar

Install

npm i route-blocker

Weekly Downloads

0

Version

1.2.1

License

MIT

Unpacked Size

9.86 kB

Total Files

14

Last publish

Collaborators

  • ehasnain