mirror of
https://github.com/Hopiu/angular.js.git
synced 2026-05-16 02:33:09 +00:00
improving $resource docs
This commit is contained in:
parent
d503dfe99b
commit
824eab9029
2 changed files with 30 additions and 16 deletions
|
|
@ -699,7 +699,7 @@ function concat(array1, array2, index) {
|
||||||
*
|
*
|
||||||
* @param {Object} self Context in which `fn` should be evaluated in.
|
* @param {Object} self Context in which `fn` should be evaluated in.
|
||||||
* @param {function()} fn Function to be bound.
|
* @param {function()} fn Function to be bound.
|
||||||
* @param {(...*)=} args Optional arguments to be prebound to the `fn` function call.
|
* @param {...*} args Optional arguments to be prebound to the `fn` function call.
|
||||||
* @returns {function()} Function that wraps the `fn` with all the specified bindings.
|
* @returns {function()} Function that wraps the `fn` with all the specified bindings.
|
||||||
*/
|
*/
|
||||||
function bind(self, fn) {
|
function bind(self, fn) {
|
||||||
|
|
|
||||||
|
|
@ -888,7 +888,7 @@ angularServiceInject('$xhr.cache', function($xhr, $defer){
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @workInProgress
|
* @workInProgress
|
||||||
* @ngdoc service
|
* @ngdoc function
|
||||||
* @name angular.service.$resource
|
* @name angular.service.$resource
|
||||||
* @requires $xhr
|
* @requires $xhr
|
||||||
*
|
*
|
||||||
|
|
@ -934,6 +934,33 @@ angularServiceInject('$xhr.cache', function($xhr, $defer){
|
||||||
expect(newCard.id).toEqual(789);
|
expect(newCard.id).toEqual(789);
|
||||||
* </pre>
|
* </pre>
|
||||||
*
|
*
|
||||||
|
* The object returned from this function execution is a resource "class" which has "static" method
|
||||||
|
* for each action in the definition.
|
||||||
|
*
|
||||||
|
* Calling these methods invoke `$xhr` on the `url` template with the given `method` and `params`.
|
||||||
|
* When the data is returned from the server then the object is an instance of the resource type and
|
||||||
|
* all of the non-GET methods are available with `$` prefix. This allows you to easily support CRUD
|
||||||
|
* operations (create, read, update, delete) on server-side data.
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
var User = $resource('/user/:userId', {userId:'@id'});
|
||||||
|
var user = User.get({userId:123}, function(){
|
||||||
|
user.abc = true;
|
||||||
|
user.$save();
|
||||||
|
});
|
||||||
|
</pre>
|
||||||
|
*
|
||||||
|
* It's worth noting that the callback for `get`, `query` and other method gets passed in the
|
||||||
|
* response that came from the server, so one could rewrite the above example as:
|
||||||
|
*
|
||||||
|
<pre>
|
||||||
|
var User = $resource('/user/:userId', {userId:'@id'});
|
||||||
|
User.get({userId:123}, function(u){
|
||||||
|
u.abc = true;
|
||||||
|
u.$save();
|
||||||
|
});
|
||||||
|
</pre>
|
||||||
|
*
|
||||||
*
|
*
|
||||||
* @param {string} url A parameterized URL template with parameters prefixed by `:` as in
|
* @param {string} url A parameterized URL template with parameters prefixed by `:` as in
|
||||||
* `/user/:username`.
|
* `/user/:username`.
|
||||||
|
|
@ -964,20 +991,7 @@ angularServiceInject('$xhr.cache', function($xhr, $defer){
|
||||||
'delete': {method:'DELETE'} };
|
'delete': {method:'DELETE'} };
|
||||||
* </pre>
|
* </pre>
|
||||||
*
|
*
|
||||||
* @returns {Object} A resource "class" which has "static" method for each action in the definition.
|
* @returns {Object} A resource "class".
|
||||||
* Calling these methods invoke `$xhr` on the `url` template with the given `method` and
|
|
||||||
* `params`. When the data is returned from the server then the object is an instance of the
|
|
||||||
* resource type and all of the non-GET methods are available with `$` prefix. This allows you
|
|
||||||
* to easily support CRUD operations (create, read, update, delete) on server-side data.
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
var User = $resource('/user/:userId', {userId:'@id'});
|
|
||||||
var user = User.get({userId:123}, function(){
|
|
||||||
user.abc = true;
|
|
||||||
user.$save();
|
|
||||||
});
|
|
||||||
</pre>
|
|
||||||
*
|
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
<script>
|
<script>
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue