.toJSON()
Purpose
This method also returns a cloned model instance. This one however includes all instance methods. Be sure to read the notes on this one.
Overview
Return Value
| Description | Possible Data Types | |
|---|---|---|
| Cloned Record | { } |
Example Usage
User.find().exec(
function(err,myRecord){
var datUser = myRecord.pop().toObject();
console.log(datUser);
});
/* { id: 2,
createdAt: '2013-10-31T22:42:25.459Z',
updatedAt: '2013-11-01T20:12:55.534Z',
name: 'Hank',
phoneNumber: '101-150-1337' } */
User.find().exec(
function(err,myRecord){
var datUser = myRecord.pop().toJSON();
console.log(datUser);
});
/* { id: 2,
createdAt: '2013-10-31T22:42:25.459Z',
updatedAt: '2013-11-01T20:12:55.534Z',
name: 'Hank' } */
// Don't forget to handle your errors
For model
module.exports = {
attributes: {
name: 'string',
phoneNumber: 'string',
// Override the default toJSON method
toJSON: function() {
var obj = this.toObject();
delete obj.phoneNumber;
return obj;
}
}
}
Usage with custom attribute methods
module.exports = {
attributes: {
// Primitive attributes
firstName: {
type: 'string',
defaultsTo: ''
},
lastName: {
type: 'string',
defaultsTo: ''
},
// Attribute methods
getFullName: function (){
return this.firstName + ' ' + this.lastName;
},
// Override the default toJSON method
toJSON: function() {
var obj = this.toObject();
obj.fullName = this.getFullName();
return obj;
}
}
}
Notes
The real power of toJSON relies on the fact every model instance sent out via res.json is first passed through toJSON. Instead of writing custom code for every controller action that uses a particular model (including the "out of the box" blueprints), you can manipulate outgoing records by simply overriding the default toJSON function in your model. You would use this to keep private data like email addresses and passwords from being sent back to every client.
This is an instance method. Currently, instance methods ARE NOT TRANSACTIONAL. Because of this, it is recommended that you use the equivalent model method instead.
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.connections
- sails.config.cors
- sails.config.csrf
- sails.config.globals
- sails.config.http
- sails.config.i18n
- sails.config.log
- sails.config.models
- sails.config.policies
- sails.config.routes
- sails.config.session
- sails.config.sockets
- sails.config.views
-
Request (`req`)
- req.accepted
- req.acceptedCharsets
- req.acceptedLanguages
- req.body
- req.cookies
- req.fresh
- req.headers
- req.host
- 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.acceptsCharset()
- req.acceptsLanguage()
- req.allParams()
- req.file()
- req.get()
- req.is()
- req.param()
- Response (`res`)
- Waterline (ORM)
- WebSockets
Built with Love
The Sails framework is maintained by a web & mobile studio 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-2018 The Sails Company.
The Sails framework is free and open-source under the MIT License.