Basic object of the router representing a server-side path available via HTTP request. For each path matching the request url, a handler (Route) is called with this bound to the context of the request (ServerRouterContext).

Initalized with the following data:

• path (string): url path in format acceptable by path-to-regexp.

• options: Optional data passed to path-to-regexp.

  • sensitive (string = false): When true the path will be case sensitive.
  • strict (string = false): When false the trailing slash is optional.
  • end (string = false): When false the path will match at the beginning.
  • delimiter (string = /): Set the default delimiter for repeat parameters.
• args (ArgsMapper) mapper of params and query to route arguments.
• route (Route) function to be called when path matches.

Type: {path: string, options: {sensitive: boolean?, strict: boolean?, end: boolean?, delimiter: string?}?, args: ArgsMapper, route: Route}

serverRouter.addPath({
  path: '/binary-representation/:n',
  args: ({ n }) => [Number(n)],
  async route(n) {
    this.res.end(n.toString(2));
  },
});
// GET /binary-representation/1337
// 10100111001

serverRouter.addPath({
  path: '/sum/:n+',
  args: ({ n }) => n.map(Number),
  async route(...nums) {
    this.res.end(String(nums.reduce((a, b) => a + b)));
  },
});
// GET /sum/1/2/3
// 6

serverRouter.addPath({
  path: '/get-query',
  args: (params, query) => [query],
  async route(query) {
    this.res.end(String(Object.keys(query)));
  },
});
// GET /get-query?a=&b=
// a,b

Function used to map params and query to actual route arguments.

Type: function (params: {}, query: {}): Array<any>

Path handler called with this bound to ServerRouterContext.

In order to respond to HTTP request, you should write to this.res object. By default, request processing is finished once your handler finishes. If you want to disable this behavior, you can return false to pass the processing to the next handler. Note that the response (this.res) must eventually be ended during the HTTP request processing by a route within ServerRouter or some other middleware.

Any exceptions thrown in handlers other than AuthenticationRequiredError are presented in response.

Type: function (): Promise<(void | boolean)>

• AuthenticationRequiredError: if access to this route requires authentication. It will cause this route to be called again with this.userId to be set to the current user (if any).

Object to which this is bound to inside your Route invocation. It provides the following:

• req (IncomingMessage): information about the incoming request.
• res (ServerResponse): use this to write data that should be sent in response to the request.
• userId (string?): the id of the current user.

This object is preserved between calling matched routes, so you can augment it.

Type: {req: IncomingMessage, res: ServerResponse, userId: string?}

Nested dictionary of Route functions. This allows for namespaces.

Type: {}

serverRouter.addRoutes({
  reports: {
    salesPDF, // available by name 'reports.salesPDF'
    employeesPDF,
  },
  images: {
    pngs: {
      async logo() { ... }, // name: 'images.pngs.logo'
    },
  },
});

Server-side routing provider of the connect API that can be used with Meteor webapp package.

WebApp.connectHandlers.use((new ServerRouter({
  routes: { ... },
  paths: [ ... ],
})).middleware);

WebApp.connectHandlers.use(ServerRouter.middleware({
  routes: { ... },
  paths: [ ... ],
}));

const serverRouter = new ServerRouter();
WebApp.connectHandlers.use(serverRouter.middleware);

serverRouter.addPaths([ ... ]);
serverRouter.addRoutes({ ... });

serverRouter.addRoutes({
  myRoute() { ... },
  privateImages: {
    img1() { ... },
    img2() { ... },
  },
});

WebApp.connectHandlers.use(serverRouter.middleware);

Thrown by routes when authentication is required for further processing.

Client for ServerRouter

const x: any = 1;
const routes: Routes = {
  Reports: {
    genReport: x,
    genReport2: x,
  },
};

serverRouterClient.redirect.privateImages.img1(800, 600);

console.log(serverRouterClient.path.privateImages.img1(800, 600));

window.location.href = 'http://www.meteor.com/';

serverRouterClient.redirectTo(serverRouterClient.getRoutePath('privateImages.img1', 800, 600));