`.toJSON()`
Waterlineがレコードを取得するたびに、そのレコードのモデルにcustomToJSON
メソッドが定義されているかどうかをチェックします。定義されている場合、WaterlineはそのメソッドをレコードのtoJSON
プロパティとして追加します。toJSON
はコード内で直接呼び出すことを意図していません。JSON.stringify()
を呼び出してレコードをシリアライズする際に自動的に使用されます。特にres.json()
メソッドはこの方法でオブジェクトを文字列化します。
モデルにcustomToJSON
が定義されている場合、.find()
、.findOne()
、.findOrCreate()
、.stream()
によって取得されたレコード、および.create()
、.createEach()
、.update()
、.destroy()
への呼び出しでfetch
メタキーをtrue
に設定して取得されたレコードに、.toJSON()
メソッドが追加されます。 .populate()
を介して子レコードが添付されており、対応するモデルにcustomToJSON
メソッドがある場合、子レコードにも.toJSON()
関数が添付されます。
customToJSONドキュメントを参照して、レコードの表示方法をカスタマイズする方法の詳細をご覧ください。