Come posso aggiungere un metodo di istanza a tutti i Modelli in sails.js?

Question

Vorrei aggiungere una funzione toDisplay predefinita a tutti i modelli che utilizzeranno i metadati, non diversamente dalle definizioni di attributo/associazione, per eseguire manipolazioni sugli attributi/associazioni dell'istanza rendendoli adatti alla visualizzazione nell'interfaccia utente.

ad esempio:

Foo.findOne(someId) 
 
    .exec(function(err, foo) { 
 
    ... 
 
    res.view({ 
 
     foo: foo.toDisplay(), 
 
    }); 
 
    });

Quindi, mi piacerebbe aggiungere questa funzione anche tutti i modelli. Posso immaginare una soluzione

Model.prototype.toDisplay = ... 

, ma non sono sicuro dove trovare Modello da (alcuni richiedono lungo) percorso ('linea di galleggiamento /..../ modello'?), E se avessi modello, dove mettere quello snip-it.

Si prega di avvisare.

Answer 1

La configurazione del modello è completamente documentata here on SailsJS.org. @umassthrower ha ragione nel sottolineare che l'aggiunta di un metodo di istanza a config/models.js lo aggiungerebbe a tutti i tuoi modelli; ha anche ragione nell'osservare che questo non è l'uso previsto del file di configurazione.

Il motivo per cui questo è un po 'più difficile in Sails che in Rails è che Ruby ha classi e eredità reali e Javascript ha solo oggetti. Un modo abbastanza pulito per simulare l'ereditarietà e estendere gli oggetti del modello da un oggetto "base" sarebbe utilizzare qualcosa come Lodash's _.merge function. Per esempio si potrebbe salvare il modello base in lib/BaseModel.js:

// lib/BaseModel.js 
module.exports = { 

    attributes: { 

    someAttribute: 'string', 

    someInstanceFunction: function() { 
     // do some amazing (synchronous) calculation here 
    } 

    } 

}; 

Poi, nel tuo file di modello, richiedono lodash e utilizzare _.extend:

// api/models/MyModel.js 
var _ = require('lodash'); 
var BaseModel = require("../../lib/BaseModel.js"); 
module.exports = _.merge({}, BaseModel, { 

    attributes: { 

    someOtherAttribute: 'integer' 

    } 

}; 

Gli attributi dal modello di base sarà fusa con MyModel, con MyModel ha la precedenza.

L'impostazione del primo argomento sul modello vuoto {} è importante qui; _.merge è distruttivo per il primo oggetto inviato, quindi se hai appena fatto _.merge(BaseModel, {...}, il modello base verrebbe modificato.

Inoltre, si ricordi di npm install lodash!

Answer 2

questo può essere fatto con l'aggiunta la funzione per il vostro modello di attributi, in questo modo:

module.exports = { 
    attributes: { 
     attribute1: { 
      type: String 
     }, 
     attribute2: { 
      type: String 
     }, 
     toDisplay: function() { 
      // your function here 
     } 

     // You can also override model functions like .toJSON or .toObject 
     toJSON: function() { 
      // your custom JSON here 
     } 
    } 
} 

C'è di più informazioni nel Sails documentation for models, sotto Metodi di attributi. Vale la pena notare che, a seconda di ciò che si sta facendo, potrebbe non essere necessario un metodo toDisplay(); potresti semplicemente ignorare il metodo toJSON() se stai solo provando a formattare un output o rimuovere qualsiasi informazione sensibile.