sails.lift()
Lift a Sails app programmatically.
This does exactly what you might be used to seeing by now when you run
sails lift. It loads the app, runs its bootstrap, then starts listening for HTTP requests and WebSocket connections. Useful for building top-to-bottom integration tests that rely on HTTP requests, and for building higher-level tooling on top of Sails.
sailsApp.lift(configOverrides, function (err) {
});
Or:
sailsApp.lift(function (err) {...});
Usage
| Argument | Type | Details | |
|---|---|---|---|
| 1 | configOverrides | A dictionary of config that will override any conflicting options present in configuration files. If provided, this will be merged on top of sails.config. |
Callback
| Argument | Type | Details | |
|---|---|---|---|
| 1 | err | An error encountered while lifting, or undefined if there were no errors. |
Example
var Sails = require('sails').constructor;
var sailsApp = new Sails();
sailsApp.lift({
log: { level: 'warn' }
}, function (err) {
if (err) {
console.log('Error occurred lifting Sails app:', err);
return;
}
// --•
console.log('Sails app lifted successfully!');
});
Notes
- The difference between
.lift()and.load()is that.lift()takes the additional steps of (1) running the app's bootstrap (if any), and (2) emitting thereadyevent. The corehttphook will typically respond to thereadyevent by starting an HTTP server on the port configured viasails.config.port(1337 by default).- When a Sails app is fully lifted, it also emits the
liftedevent.- With the exception of
NODE_ENVandPORT, configuration set via environment variables will not automatically apply to apps started using.lift(), nor will options set in.sailsrcfiles. If you wish to use those configuration values, you can retrieve them viarequire('sails/accessible/rc')('sails')and pass them in as the first argument to.lift().
For a better experience on sailsjs.com, update your browser.
Reference
- Application
- Blueprint API
- Command-line interface
-
Configuration
- sails.config.*
- sails.config.blueprints
- sails.config.bootstrap()
- sails.config.custom
- sails.config.datastores
- sails.config.globals
- sails.config.http
- sails.config.i18n
- sails.config.log
- sails.config.models
- sails.config.policies
- sails.config.routes
- sails.config.security
- sails.config.session
- sails.config.sockets
- sails.config.views
-
Request (`req`)
- req._startTime
- req.body
- req.cookies
- req.fresh
- req.headers
- req.hostname
- req.ip
- req.ips
- req.isSocket
- req.method
- req.options
- req.originalUrl
- req.params
- req.path
- req.protocol
- req.query
- req.secure
- req.signedCookies
- req.socket
- req.subdomains
- req.url
- req.wantsJSON
- req.xhr
- req.accepts()
- req.acceptsCharsets()
- req.acceptsLanguages()
- req.allParams()
- req.file()
- req.get()
- req.is()
- req.param()
- req.setLocale()
- req.setTimeout()
- req.host
- Response (`res`)
- Waterline (ORM)
- WebSockets
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!
© 2012-2023 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.