Hopiu/angular.js
1
0
Fork 0
mirror of https://github.com/Hopiu/angular.js.git synced 2026-03-17 07:40:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs($provide): improve examples and explanations

Browse source 
$provide's example seems awkward. Replace with more real-world example,
using an injected service, where the service defined has a good reason to
be a singleton.

There's quite a lot of confusion around $provide:
http://stackoverflow.com/search?q=angularjs+service+vs+factory
Tests for example at: http://jsbin.com/EMabAv/1/edit?js,output
This commit is contained in:
Tim Ruffles 2013-10-06 23:01:03 +01:00 committed by Pete Bacon Darwin
parent 8469779a8e
commit 85b7d24357
1 changed files with 64 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

90
src/auto/injector.js
View file

@ -260,39 +260,76 @@ function annotate(fn) {
* a service. The Provider can have additional methods which would allow for configuration of the provider.
*
* <pre>
* function GreetProvider() {
* var salutation = 'Hello';
*
* this.salutation = function(text) {
* salutation = text;
* };
*
* this.$get = function() {
* return function (name) {
* return salutation + ' ' + name + '!';
* function TrackingProvider() {
* this.$get = function($http) {
* var observed = {};
* return {
* event: function(event) {
* var current = observed[event];
* return observed[event] = current ? current + 1 : 1;
* },
* save: function() {
* $http.post("/track",observed);
* }
* };
* };
* }
*
* describe('Greeter', function(){
*
* describe('Tracking', function() {
* var mocked;
* beforeEach(module(function($provide) {
* $provide.provider('greet', GreetProvider);
* $provide.provider('tracking', TrackingProvider);
* mocked = {post: jasmine.createSpy('postSpy')};
* $provide.value('$http',mocked);
* }));
* it('allows events to be tracked', inject(function(tracking) {
* expect(tracking.event('login')).toEqual(1);
* expect(tracking.event('login')).toEqual(2);
* }));
*
* it('should greet', inject(function(greet) {
* expect(greet('angular')).toEqual('Hello angular!');
* it('posts to save', inject(function(tracking) {
* tracking.save();
* expect(mocked.post.callCount).toEqual(1);
* }));
*
* it('should allow configuration of salutation', function() {
* module(function(greetProvider) {
* greetProvider.salutation('Ahoj');
* });
* inject(function(greet) {
* expect(greet('angular')).toEqual('Ahoj angular!');
* });
* });
* });
* </pre>
*
* There are also shorthand methods to define services that don't need to be configured beyond their `$get()` method.
*
* `service()` registers a constructor function which will be invoked with `new` to create the instance. You can specify services that will be provided by the injector.
*
* <pre>
* function TrackingProvider($http) {
* var observed = {};
* this.event = function(event) {
* var current = observed[event];
* return observed[event] = current ? current + 1 : 1;
* };
* this.save = function() {
* $http.post("/track",observed);
* };
* }
* $provider.service('tracking',TrackingProvider);
* </pre>
*
* `factory()` registers a function whose return value is the instance. Again, you can specify services that will be provided by the injector.
*
* <pre>
* function TrackingProvider($http) {
* var observed = {};
* return {
* event: function(event) {
* var current = observed[event];
* return observed[event] = current ? current + 1 : 1;
* },
* save: function() {
* $http.post("/track",observed);
* }
* };
* }
* $provider.factory('tracking',TrackingProvider);
* </pre>
*
*/
/**
@ -320,7 +357,7 @@ function annotate(fn) {
* @methodOf AUTO.$provide
* @description
*
* A short hand for configuring services if only `$get` method is required.
* A service whose instance is the return value of `$getFn`. Short hand for configuring services if only `$get` method is required.
*
* @param {string} name The name of the instance.
* @param {function()} $getFn The $getFn for the instance creation. Internally this is a short hand for
@ -335,7 +372,7 @@ function annotate(fn) {
* @methodOf AUTO.$provide
* @description
*
* A short hand for registering service of given class.
* A service whose instance is created by invoking `constructor` with `new`. A short hand for registering services which use a constructor.
*
* @param {string} name The name of the instance.
* @param {Function} constructor A class (constructor function) that will be instantiated.
@ -602,3 +639,4 @@ function createInjector(modulesToLoad) {
};
}
}