Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

AngularJS $resource @ prefixed parameter

I am learning AngularJS and reading its API

Angular JS Resource

It says "If the parameter value is prefixed with @ then the value of that parameter is extracted from the data object " with code example:

var User = $resource('/user/:userId', {userId:'@id'});
var user = User.get({userId:123}, function() {
  user.abc = true;
  user.$save();
});

I am so slow that after the example I still don't get what the prefixed @ means/does. Could someone please give me some examples With and Without the @ and elaborate it? Thanks...

like image 773
Tom Avatar asked Nov 02 '12 01:11

Tom


1 Answers

Sure.

It means that the value of :userId in your url will be replaced with the id property from the user object when that property is required.

So when is it required? Its required when you are doing something to an existing user, like geting one, updating one. It is not required when you create a user.

In most cases, you will want to have at least one param prefixed with @ in your REST url that resource uses (probably the object id). If you dont have one, that means that in order for you to save an instance of an object, you dont need to know anything about where its stored. This implies that its a singleton object. Maybe like a settings object.

Here is your long awaited example:

var User = $resource('/user/:userId/:dogName', {userId:'@id', dogName:@dog});
User.get({userId:123, dog:'Matt'}, function() { .. })

will produce the request: GET /user/123/Matt

like image 78
mkoryak Avatar answered Oct 04 '22 20:10

mkoryak