mirror of
https://github.com/angular/angular
synced 2026-05-24 09:28:37 +00:00
It is possible for a class defined first to be referencing a class defined later, and as a result at the time of the definition it is not possible to access the later's class reference. This allows to refer to the later defined class through a closure.Closes #1891
50 lines
1.3 KiB
TypeScript
50 lines
1.3 KiB
TypeScript
import {Type} from 'angular2/src/facade/lang';
|
|
|
|
export interface ForwardRefFn { (): Type; }
|
|
|
|
/**
|
|
* Allows to refer to references which are not yet defined.
|
|
*
|
|
* This situation arises when the key which we need te refer to for the purposes of DI is declared,
|
|
* but not yet defined.
|
|
*
|
|
* ## Example:
|
|
*
|
|
* ```
|
|
* class Door {
|
|
* // Incorrect way to refer to a reference which is defined later.
|
|
* // This fails because `Lock` is undefined at this point.
|
|
* constructor(lock:Lock) { }
|
|
*
|
|
* // Correct way to refer to a reference which is defined later.
|
|
* // The reference needs to be captured in a closure.
|
|
* constructor(@Inject(forwardRef(() => Lock)) lock:Lock) { }
|
|
* }
|
|
*
|
|
* // Only at this point the lock is defined.
|
|
* class Lock {
|
|
* }
|
|
* ```
|
|
*
|
|
* @exportedAs angular2/di
|
|
*/
|
|
export function forwardRef(forwardRefFn: ForwardRefFn): Type {
|
|
(<any>forwardRefFn).__forward_ref__ = forwardRef;
|
|
return (<Type><any>forwardRefFn);
|
|
}
|
|
|
|
/**
|
|
* Lazily retrieve the reference value.
|
|
*
|
|
* See: {@link forwardRef}
|
|
*
|
|
* @exportedAs angular2/di
|
|
*/
|
|
export function resolveForwardRef(type: any): any {
|
|
if (typeof type == 'function' && type.hasOwnProperty('__forward_ref__') &&
|
|
type.__forward_ref__ === forwardRef) {
|
|
return (<ForwardRefFn>type)();
|
|
} else {
|
|
return type;
|
|
}
|
|
}
|