d169c2434e
- Introduce `InjectionToken<T>` which is a parameterized and type-safe
version of `OpaqueToken`.
DEPRECATION:
- `OpaqueToken` is now deprecated, use `InjectionToken<T>` instead.
- `Injector.get(token: any, notFoundValue?: any): any` is now deprecated
use the same method which is now overloaded as
`Injector.get<T>(token: Type<T>|InjectionToken<T>, notFoundValue?: T): T;`.
Migration
- Replace `OpaqueToken` with `InjectionToken<?>` and parameterize it.
- Migrate your code to only use `Type<?>` or `InjectionToken<?>` as
injection tokens. Using other tokens will not be supported in the
future.
BREAKING CHANGE:
- Because `injector.get()` is now parameterize it is possible that code
which used to work no longer type checks. Example would be if one
injects `Foo` but configures it as `{provide: Foo, useClass: MockFoo}`.
The injection instance will be that of `MockFoo` but the type will be
`Foo` instead of `any` as in the past. This means that it was possible
to call a method on `MockFoo` in the past which now will fail type
check. See this example:
```
class Foo {}
class MockFoo extends Foo {
setupMock();
}
var PROVIDERS = [
{provide: Foo, useClass: MockFoo}
];
...
function myTest(injector: Injector) {
var foo = injector.get(Foo);
// This line used to work since `foo` used to be `any` before this
// change, it will now be `Foo`, and `Foo` does not have `setUpMock()`.
// The fix is to downcast: `injector.get(Foo) as MockFoo`.
foo.setUpMock();
}
```
PR Close #13785
65 lines
2.0 KiB
TypeScript
65 lines
2.0 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright Google Inc. All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
|
|
import {InjectionToken} from '@angular/core';
|
|
import {LocationChangeListener} from './platform_location';
|
|
|
|
/**
|
|
* `LocationStrategy` is responsible for representing and reading route state
|
|
* from the browser's URL. Angular provides two strategies:
|
|
* {@link HashLocationStrategy} and {@link PathLocationStrategy}.
|
|
*
|
|
* This is used under the hood of the {@link Location} service.
|
|
*
|
|
* Applications should use the {@link Router} or {@link Location} services to
|
|
* interact with application route state.
|
|
*
|
|
* For instance, {@link HashLocationStrategy} produces URLs like
|
|
* `http://example.com#/foo`, and {@link PathLocationStrategy} produces
|
|
* `http://example.com/foo` as an equivalent URL.
|
|
*
|
|
* See these two classes for more.
|
|
*
|
|
* @stable
|
|
*/
|
|
export abstract class LocationStrategy {
|
|
abstract path(includeHash?: boolean): string;
|
|
abstract prepareExternalUrl(internal: string): string;
|
|
abstract pushState(state: any, title: string, url: string, queryParams: string): void;
|
|
abstract replaceState(state: any, title: string, url: string, queryParams: string): void;
|
|
abstract forward(): void;
|
|
abstract back(): void;
|
|
abstract onPopState(fn: LocationChangeListener): void;
|
|
abstract getBaseHref(): string;
|
|
}
|
|
|
|
|
|
/**
|
|
* The `APP_BASE_HREF` token represents the base href to be used with the
|
|
* {@link PathLocationStrategy}.
|
|
*
|
|
* If you're using {@link PathLocationStrategy}, you must provide a provider to a string
|
|
* representing the URL prefix that should be preserved when generating and recognizing
|
|
* URLs.
|
|
*
|
|
* ### Example
|
|
*
|
|
* ```typescript
|
|
* import {Component, NgModule} from '@angular/core';
|
|
* import {APP_BASE_HREF} from '@angular/common';
|
|
*
|
|
* @NgModule({
|
|
* providers: [{provide: APP_BASE_HREF, useValue: '/my/app'}]
|
|
* })
|
|
* class AppModule {}
|
|
* ```
|
|
*
|
|
* @stable
|
|
*/
|
|
export const APP_BASE_HREF = new InjectionToken<string>('appBaseHref');
|