cargdev/angular
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(di): Edits to DI.

Browse Source 
Closes #1420
This commit is contained in:
Naomi Black
2015-04-17 03:29:05 -07:00
committed by Misko Hevery
parent 97220dd2ba
commit de31aca7a7
13 changed files with 113 additions and 107 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
modules/angular2/src/di/binding.js vendored
View File

@ -50,16 +50,16 @@ var _EMPTY_LIST = []; // TODO: make const when supported
export class Binding {
/**
* Token used when retriving this binding. Usually the [Type].
* Token used when retrieving this binding. Usually the [Type].
*/
token;
/**
* Bind an interface to an implementation / subclass.
* Binds an interface to an implementation / subclass.
*
* ## Example
*
* Becuse `toAlias` and `toClass` are often confused the example contains both use cases for easy comparison.
* Becuse `toAlias` and `toClass` are often confused, the example contains both use cases for easy comparison.
*
* ```javascript
*
@ -86,7 +86,7 @@ export class Binding {
toClass:Type;
/**
* Bind a key to a value.
* Binds a key to a value.
*
* ## Example
*
@ -101,10 +101,10 @@ export class Binding {
toValue;
/**
* Bind a key to an alias of an existing key.
* Binds a key to the alias for an existing key.
*
* An alias means that we will return the same instance as if the alias token was used. (This is in contrast to
* `toClass` where a separet instance of `toClass` will be returned.)
* An alias means that [Injector] returns the same instance as if the alias token was used. This is in contrast to
* `toClass` where a separate instance of `toClass` is returned.
*
* ## Example
*
@ -127,7 +127,7 @@ export class Binding {
*
* expect(injectorAlias.get(Vehicle)).toBe(injectorAlias.get(Car));
* expect(injectorAlias.get(Vehicle) instanceof Car).toBe(true);
*
* expect(injectorClass.get(Vehicle)).not.toBe(injectorClass.get(Car));
* expect(injectorClass.get(Vehicle) instanceof Car).toBe(true);
* ```
@ -135,7 +135,7 @@ export class Binding {
toAlias;
/**
* Bind a key to a function which computes the value.
* Binds a key to a function which computes the value.
*
* ## Example
*
@ -153,7 +153,7 @@ export class Binding {
toFactory:Function;
/**
* Bind a key to a function which computes the value asynchronously.
* Binds a key to a function which computes the value asynchronously.
*
* ## Example
*
@ -170,15 +170,17 @@ export class Binding {
* injector.asyncGet(String).then((v) => expect(v).toBe('Value: 3'));
* ```
*
* The interesting thing to note is that event thougt `Numeber` has an async factory, the `String` factory
* function takes the resolved value. This shows that the [Injector] delays executing of the `String` factory
* until after the `Number` is resolved. This can only be done if the `token` is retrive
* The interesting thing to note is that event though `Number` has an async factory, the `String` factory
* function takes the resolved value. This shows that the [Injector] delays executing the `String` factory
* until after the `Number` is resolved. This can only be done if the `token` is retrieved using the
* [Injector.asyncGet] API.
*
*/
toAsyncFactory:Function;
/**
* Used in conjunction with `toFactory` or `toAsyncFactory` and specifies the `token`s which should be injected
* into the factory function.
* Used in conjunction with `toFactory` or `toAsyncFactory` and specifies a set of dependencies (as `token`s) which
* should be injected into the factory function.
*
* ## Example
*
@ -216,7 +218,9 @@ export class Binding {
}
/**
*
* Converts the [Binding] into [ResolvedBinding].
*
* [Injector] internaly only uses [ResolvedBindings], [Binding] contains convenience sugar.
*/
resolve(): ResolvedBinding {
var factoryFn:Function;
@ -250,29 +254,31 @@ export class Binding {
}
/**
* An internal resolved representaion of a [Binding] used by [Injector].
*
* A [Binding] is resolved when it has a factory fonction. Binding to a class, alias, or value, are just convenience
* methods, as [Injector] only operates on calling factory functions.
* An internal resolved representation of a [Binding] used by the [Injector].
*
* A [Binding] is resolved when it has a factory function. Binding to a class, alias, or value, are just convenience
* methods, as [Injector] only operates on calling factory functions.
*
* @exportedAs angular2/di
*/
export class ResolvedBinding {
/**
* A key, usually a [Type].
*/
key:Key;
/**
* Factory function which can return an instance of [key].
* Factory function which can return an instance of represented by a [key].
*/
factory:Function;
/**
* Arguments (dependencies) to the [factory] function.
*/
dependencies:List<Dependency>;
/**
* Specifies if the [factory] function returns an [Promise]
* Specifies whether the [factory] function returns a [Promise].
*/
providedAsPromise:boolean;
@ -285,7 +291,9 @@ export class ResolvedBinding {
}
/**
* Provides fluent API for imperative construction of [Binding] objects. (JavaScript only.)
* Provides an API for imperatively constructing [Binding]s.
*
* This is only relevant for JavaScript.
*
* @exportedAs angular2/di
*/
@ -294,7 +302,8 @@ export function bind(token):BindingBuilder {
}
/**
* Helper class for [bind] function.
* Helper class for the [bind] function.
*
* @exportedAs angular2/di
*/
export class BindingBuilder {
@ -305,11 +314,11 @@ export class BindingBuilder {
}
/**
* Bind an interface to an implementation / subclass.
* Binds an interface to an implementation / subclass.
*
* ## Example
*
* Becuse `toAlias` and `toClass` are often confused the example contains both use cases for easy comparison.
* Because `toAlias` and `toClass` are often confused, the example contains both use cases for easy comparison.
*
* ```javascript
*
@ -338,7 +347,7 @@ export class BindingBuilder {
}
/**
* Bind a key to a value.
* Binds a key to a value.
*
* ## Example
*
@ -355,14 +364,14 @@ export class BindingBuilder {
}
/**
* Bind a key to an alias of an existing key.
* Binds a key to the alias for an existing key.
*
* An alias means that we will return the same instance as if the alias token was used. (This is in contrast to
* `toClass` where a separet instance of `toClass` will be returned.)
*
* ## Example
*
* Becuse `toAlias` and `toClass` are often confused the example contains both use cases for easy comparison.
* Becuse `toAlias` and `toClass` are often confused, the example contains both use cases for easy comparison.
*
* ```javascript
*
@ -381,7 +390,7 @@ export class BindingBuilder {
*
* expect(injectorAlias.get(Vehicle)).toBe(injectorAlias.get(Car));
* expect(injectorAlias.get(Vehicle) instanceof Car).toBe(true);
*
* expect(injectorClass.get(Vehicle)).not.toBe(injectorClass.get(Car));
* expect(injectorClass.get(Vehicle) instanceof Car).toBe(true);
* ```
@ -391,7 +400,7 @@ export class BindingBuilder {
}
/**
* Bind a key to a function which computes the value.
* Binds a key to a function which computes the value.
*
* ## Example
*
@ -413,7 +422,7 @@ export class BindingBuilder {
}
/**
* Bind a key to a function which computes the value asynchronously.
* Binds a key to a function which computes the value asynchronously.
*
* ## Example
*
@ -429,9 +438,10 @@ export class BindingBuilder {
* injector.asyncGet(String).then((v) => expect(v).toBe('Value: 3'));
* ```
*
* The interesting thing to note is that event thougt `Numeber` has an async factory, the `String` factory
* The interesting thing to note is that event though `Number` has an async factory, the `String` factory
* function takes the resolved value. This shows that the [Injector] delays executing of the `String` factory
* until after the `Number` is resolved. This can only be done if the `token` is retrive
* until after the `Number` is resolved. This can only be done if the `token` is retrieved using the
* [Injector.asyncGet] API.
*/
toAsyncFactory(factoryFunction:Function, dependencies:List = null):Binding {
return new Binding(this.token, {