angular-sails icon indicating copy to clipboard operation
angular-sails copied to clipboard

API Information

Open tommykennedy opened this issue 10 years ago • 3 comments

I am trying to use $sails.get and was wondering where the API was documented.

I want to pass some information in the request.

tommykennedy avatar Aug 05 '15 10:08 tommykennedy

+1

ghost avatar Aug 27 '15 20:08 ghost

1.x is a wrapper for the sails.io client and as noted in the read me you can refer to the sails socket documention for the API. That documentation at least indicates what methods are available. 1.x wraps it so that you don't have to do all of the $apply() stuff and also provides a promise instead of accepting a callback.

2.x is a implementation of angular's $http that uses sockets to communicate with sails. You can refer to the angular $http documentation for methods (this is noted in the 2.x readme). Anything you can do with $http you can do with $sails in 2.x. If you can't do something that $http can do, file a defect.

Yeah, angular-sails should have it's own documentation rather than just referring to others in the readme...

TheSharpieOne avatar Aug 27 '15 21:08 TheSharpieOne

Thanks Evan, I'll bare that in mind. If I find some time I'll submit a pull request with some more detailed updated docs.

ghost avatar Aug 28 '15 09:08 ghost