UNPKG

sails

Version:

API-driven framework for building realtime apps, using MVC conventions (based on Express and Socket.io)

45 lines (29 loc) 1.15 kB
# sails.lower() Shut down a lifted Sails app and have it cease listening for or responding to any future requests. ```usage sails.lower(callback); ``` ### Usage | | Argument | Type | Details |---| --------------------------- | ------------------- | ----------- | 1 | _`callback`_ | ((function?)) | Optional. A function to call when lowering is complete (or if an error occurs) ##### Callback | | Argument | Type | Details | |---|-----------|:------------:|---------| | 1 | _`err`_ | ((Error?)) | An error instance will be sent as the first argument of the callback if any fatal errors occurred while lowering. ### Example ```javascript sailsApp.lower( function (err) { if (err) { return console.log("Error occurred lowering Sails app: ", err); } console.log("Sails app lowered successfully!"); } ) ``` ### Notes > + The app will emit the `lower` event before shutting down the HTTP and WebSocket services. > + Lowered apps cannot be lifted again. <docmeta name="displayName" value="sails.lower()"> <docmeta name="pageType" value="method">