.toJSON()
Purpose
#Whenever Waterline retrieves a record, it checks whether or not the record’s model has a customToJSON method defined; if so, Waterline adds the method to the record as its toJSON property. toJSON is not intended to be called directly in your code. Instead, it is used automatically when a record is serialized via a call to JSON.stringify(). The res.json() method, in particular, stringifies objects in this way.
When a customToJSON is defined for a model, the .toJSON() method will be added to records retrieved via .find(), .findOne(), .findOrCreate() and .stream(), as well as those retrieved by setting the fetch meta key to true in calls to .create(), .createEach(), .update() and .destroy(). If any child records are attached via .populate(), and the corresponding models have customToJSON methods, then the child records will also have .toJSON() functions attached.
See the customToJSON documentation for more info on how to customize the way your records are presented.
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`)
- WebSockets
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!
© 2012-2025 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.