Edit Page

`res.view()`

Respond with an HTML page.

Usage

return res.view(pathToView, locals);

Or:

return res.view(pathToView);
return res.view(locals);
return res.view();

Uses the configured view engine to compile the view template at pathToView into HTML. If pathToView is not provided, serves the conventional view based on the current controller and action.

The specified locals are merged with your configured app-wide locals, as well as certain built-in locals from Sails and/or your view engine, then passed to the view engine as data.

Arguments

	Argument	Type	Details
1	pathToView		The path to the desired view file relative to your app's `views` folder (usually `views/`), without the file extension (e.g. `.ejs`), and with no trailing slash. Defaults to "identityOfController/nameOfAction".
2	locals		Data to pass to the view template. These explicitly specified locals will be merged in to Sails' built-in locals and your configured app-wide locals. Defaults to `{}`.

Example

Consider a conventionally configured Sails app with a call to res.view() in the cook() action of its OvenController.js.

With no pathToView argument, res.view() will decide the path by combining the identity of the controller (oven) and the name of the action (cook):

return res.view();
// -> responds with `views/oven/cook.ejs`

Here's how you would load the same view using an explicit pathToView:

return res.view('oven/cook');
// -> responds with `views/oven/cook.ejs`

Finally, here's a more involved example demonstrating how res.view can be combined with Waterline queries:

// Find the 5 hottest oven brands on the market
Oven.find().sort('heat ASC').exec(function (err, ovens){
  if (err) return res.serverError(err);

  return res.view('oven/top5', {
    hottestOvens: ovens
  });
  // -> responds using the view at `views/oven/top5.ejs`,
  // and with the oven data we looked up as view locals.
  //
  // e.g. in the view, we might have something like:
  // ...
  // <% _.each(hottestOvens, function (aHotOven) { %>
  //  <li><%= aHotOven.name %></li>
  // <% }) %>
  // ...
});

Notes

This method is terminal, meaning that it is generally the last line of code your app should run for a given request (hence the advisory usage of return throughout these docs).

res.view() reads a view file from disk, compiles it into HTML, then streams it back to the client. If you already have the view in memory, or don't want to stream the compiled HTML directly back to the client, use sails.hooks.views.render() instead.

res.view() always looks for the lowercased version of a view filename. For example, if your controller is FooBarController and your action is Baz, res.view() will attempt to find views/foobar/baz.ejs. On case-sensitive filesystems (e.g. Ubuntu Linux), this can lead to unexpected errors when locating views if they are saved with capital letters. For this reason, it is recommended that you always save your views and view folders in lowercase.

Is something missing?

If you notice something we've missed or could be improved on, please follow this link and submit a pull request to the sails repo. Once we merge it, the changes will be reflected on the website the next time it is deployed.

Documentation

Reference

Built with Love

The Sails framework is built by a web & mobile shop in Austin, TX, with the help of our contributors. We created Sails in 2012 to assist us on Node.js projects. Naturally we open-sourced it. We hope it makes your life a little bit easier!

Sails:

About:

Help:

© 2012-2024 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.