Page Contents

Synopsis

Adds a new middleware configuration to an existing LoopBack application.

$ lb middleware [options] [<name>]

With legacy StrongLoop tools:

$ slc loopback:middleware [options] [<name>]

Options

-h, --help Print the generator’s options and usage.

--skip-cache Do not remember prompt answers. Default is false.

--skip-install Do not automatically install dependencies. Default is false.

Arguments

You can optionally provide the name of the middleware function to create as an argument.  If you do, the tool will use that as the default when it prompts for the name.

Interactive prompts

The tool will prompt you for:

  • Name of the new middleware function.  If you supplied a name on the command-line, just hit Enter to use it.
  • Phase when the middleware function will be invoked.  You can select any of the predefined phases or a custom phase. For more information about middleware phases, see Defining middleware.
  • Sub-phase when the middleware function will be invoked (before, regular, or after).
  • Paths (routes) that will invoke the middleware function.
  • Configuration parameters in JSON format.

Output

The tools adds the specified middleware to the application’s middleware.json file

Examples

Here is an example of adding middleware to an existing phase.

$ lb middleware
? Enter the middleware name: m1
? Select the phase for m1: 5. routes
? Select the sub phase for m1: 1. before
Specify paths for m1:
Enter an empty path name when done.
? Path uri: /x
Let's add another path.
Enter an empty path name when done.
? Path uri:
? Configuration parameters in JSON format: {"a": 1}
Middleware m1 is added to phase routes.

The following is an example to add a middleware to a custom phase.

$ lb middleware
? Enter the middleware name: m2
? Select the phase for m2: (custom phase)
? Enter the phase name: p1
? Select the phase before which the new one will be inserted: 4. parse
? Select the sub phase for m2: 2. regular
Specify paths for m2:
Enter an empty path name when done.
? Path uri: /a
Let's add another path.
? Configuration parameters in JSON format: {"x": "2"}
Middleware m2 is added to phase p1.