Table of Contents

  1. Application
    1. Events
    2. Lifecycle
    3. sails.getRouteFor()
    4. sails.getUrlFor()
    5. sails.lift()
    6. sails.load()
    7. sails.log()
    8. sails.lower()
    9. sails.request()
    10. sails.getBaseUrl()
  2. Blueprint API
    1. add to
    2. create
    3. destroy
    4. find one
    5. find where
    6. populate where
    7. remove from
    8. update
  3. Command Line Interface
    1. sails console
    2. sails debug
    3. sails generate
    4. sails lift
    5. sails new
    6. sails version
  4. Configuration
    1. sails.config.*
    2. sails.config.blueprints
    3. sails.config.bootstrap()
    4. sails.config.connections
    5. sails.config.cors
    6. sails.config.csrf
    7. sails.config.globals
    8. sails.config.http
    9. sails.config.i18n
    10. sails.config.log
    11. sails.config.models
    12. sails.config.policies
    13. sails.config.routes
    14. sails.config.session
    15. sails.config.sockets
    16. sails.config.views
  5. Request (`req`)
    1. req.accepted
    2. req.acceptedCharsets
    3. req.acceptedLanguages
    4. req.body
    5. req.cookies
    6. req.fresh
    7. req.headers
    8. req.host
    9. req.ip
    10. req.ips
    11. req.isSocket
    12. req.method
    13. req.options
      1. req.options.values
      2. req.options.where
    14. req.originalUrl
    15. req.params
    16. req.path
    17. req.protocol
    18. req.query
    19. req.secure
    20. req.signedCookies
    21. req.socket
    22. req.subdomains
    23. req.url
    24. req.wantsJSON
    25. req.xhr
    26. req.accepts()
    27. req.acceptsCharset()
    28. req.acceptsLanguage()
    29. req.allParams()
    30. req.file()
    31. req.get()
    32. req.is()
    33. req.param()
  6. Response (`res`)
    1. res.attachment()
    2. res.badRequest()
    3. res.clearCookie()
    4. res.cookie()
    5. res.created()
    6. res.forbidden()
    7. res.get()
    8. res.json()
    9. res.jsonp()
    10. res.location()
    11. res.negotiate()
    12. res.notFound()
    13. res.ok()
    14. res.redirect()
    15. res.send()
    16. res.serverError()
    17. res.set()
    18. res.status()
    19. res.type()
    20. res.view()
  7. Waterline (ORM)
    1. Models
      1. .count()
      2. .create()
      3. .destroy()
      4. .find()
      5. .findOne()
      6. .findOrCreate()
      7. .native()
      8. .query()
      9. .stream()
      10. .update()
    2. Populated Values
      1. .add()
      2. .remove()
    3. Queries
      1. .exec()
      2. .limit()
      3. .populate()
      4. .skip()
      5. .sort()
      6. .where()
    4. Records
      1. .save()
      2. .toJSON()
      3. .toObject()
  8. WebSockets
    1. Resourceful PubSub
      1. .message()
      2. .publishAdd()
      3. .publishCreate()
      4. .publishDestroy()
      5. .publishRemove()
      6. .publishUpdate()
      7. .subscribe()
      8. .unsubscribe()
      9. .unwatch()
      10. .watch()
      11. .subscribers()
    2. sails.sockets
      1. .addRoomMembersToRooms()
      2. .blast()
      3. .broadcast()
      4. .getId()
      5. .join()
      6. .leave()
      7. .leaveAll()
      8. .removeRoomMembersFromRooms()
      9. sails.sockets.emit()
      10. sails.sockets.id()
      11. sails.sockets.rooms()
      12. sails.sockets.socketRooms()
      13. sails.sockets.subscribers()
    3. Socket Client
      1. io.sails
      2. io.socket
      3. SailsSocket
        1. Methods
        2. Properties
      4. io.socket.delete()
      5. io.socket.get()
      6. io.socket.off()
      7. io.socket.on()
      8. io.socket.post()
      9. io.socket.put()
      10. io.socket.request()

Using Sails at work?

If your company has the budget, consider purchasing Flagship support. It's a great way to support the ongoing development of the open source tools you use every day. And it gives you an extra lifeline to the Sails core team.

Documentation

Reference Concepts App structure | Upgrading Contribution guide | Tutorials More

Reference