docs($resource): document Resource#toJSON

Document the `toJSON` method of `Resource` instances as part of its public API.

See #14637
Closes #14725
This commit is contained in:
J. Roberto Vidal
2016-06-07 08:53:16 +00:00
committed by Peter Bacon Darwin
parent 186bd0df0e
commit 78a23ccea2
+8
View File
@@ -265,6 +265,14 @@ function shallowClearAndCopy(src, dst) {
* - `$cancelRequest`: If there is a cancellable, pending request related to the instance or
* collection, calling this method will abort the request.
*
* The Resource instances have these additional methods:
*
* - `toJSON`: It returns a simple object without any of the extra properties added as part of
* the Resource API. This object can be serialized through {@link angular.toJson} safely
* without attaching Angular-specific fields. Notice that `JSON.stringify` (and
* `angular.toJson`) automatically use this method when serializing a Resource instance
* (see [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#toJSON()_behavior)).
*
* @example
*
* # Credit card resource