Add note about initialValues mutation to create() and createEach() …

…doc pages
balderdashy · Jun 16, 2023 · ed6bf2e · ed6bf2e
1 parent 59b9644
commit ed6bf2e
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/docs/reference/waterline/models/create.md b/docs/reference/waterline/models/create.md
@@ -16,6 +16,8 @@ or
 |---|:--------------------|------------------------------|:--------------------------------------|
 | 1 | initialValues | ((dictionary)) | The initial values for the new record. _(Note that, if this model is in ["schemaful" mode](https://sailsjs.com/documentation/concepts/models-and-orm/model-settings#?schema), then any extraneous keys will be silently omitted.)_
 
+> **Note**: For performance reasons, as of Sails v1.0 / Waterline 0.13, the `initialValues` dictionary passed into this model method will be mutated in-place in most situations (whereas in Sails/Waterline v0.12, this was not necessarily the case).
+
 ##### Result
 
 | Type | Description |

diff --git a/docs/reference/waterline/models/createEach.md b/docs/reference/waterline/models/createEach.md
@@ -17,6 +17,7 @@ or
 |---|:--------------------|----------------------------------------------|:-----------------------------------|
 | 1 | initialValues | ((array?)) | An array of dictionaries with attributes for the new records.
 
+> **Note**: For performance reasons, as of Sails v1.0 / Waterline 0.13, the dictionaries in the `initialValues` array passed into this model method will be mutated in-place in most situations (whereas in Sails/Waterline v0.12, this was not necessarily the case).
 
 
 ##### Result