Edit Page

res.serverError()

This method is used to send a 500 ("Server Error") response back down to the client, indicating that some kind of server error occurred (i.e. the error is not the requesting user agent's fault).

Usage

return res.serverError(err);

Or:

  • return res.serverError();

Details

Like the other built-in custom response modules, the behavior of this method is customizable.

By default, it works as follows:

  • The status code of the response will be set to 500.

  • If the request "wants JSON" (e.g. the request originated from AJAX, WebSockets, or a REST client like cURL), Sails will send the provided error data as JSON. If no data is provided, a default response body will be sent (the string "Internal Server Error").

  • If the request does not "want JSON" (e.g. a URL typed into a web browser), Sails will attempt to serve the view located at views/500.ejs (assuming the default EJS view engine). If no such view is found, or an error occurs attempting to serve it, a default response body will be sent with the string "Internal Server Error".

Example

return res.serverError('Salesforce could not be reached');

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.serverError() (like other userland response methods) can be overridden or modified. It runs the response method defined in api/responses/serverError.js. If a serverError.js response method does not exist in your app, Sails will use the default behavior.
  • The specified data will be excluded from the JSON response and view locals if the app is running in the "production" environment (i.e. process.env.NODE_ENV === 'production').

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.

Check out the official Sails VS Code extension

Documentation

Reference

Sails logo

Reference

AltStyle によって変換されたページ (->オリジナル) /