From 262a1141caecc2d3be22e24c9ba7f9a0c7a4e956 Mon Sep 17 00:00:00 2001 From: Marvin Tam Date: Mon, 26 Mar 2012 16:57:16 +0800 Subject: [PATCH] document caveat on getters regarding Model.update() --- docs/getters-setters.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/getters-setters.md b/docs/getters-setters.md index 7cf7b94243d..cdba99da0f1 100644 --- a/docs/getters-setters.md +++ b/docs/getters-setters.md @@ -47,6 +47,9 @@ Suppose you are storing credit card numbers and you want to hide everything exce console.log(found.creditCardNumber); // '****-****-****-1234' }); + +**Important!** Note that getters only works when creating or modifying `Document` instances; it will not be invoked when `Document` instances are not involved like in `Model.update()`. + ## Summary Setters are intended to modify the underlying raw data. Getters are intended to transform (but not modify at the raw data level) the underlying raw data into something that the user expects to see. They are both defined in the `Schema` definition.