8f074296c2
@angular/core/testing provide `async` test utility, but the name `async` is
confusing with the javascript keyword `async`. And in some test case, if you
want to use both the `async` from `@angular/core/testing` and `async/await`,
you may have to write the code like this.
```typescript
it('test async operations', async(async() => {
const result = await asyncMethod();
expect(result).toEqual('expected');
}));
```
So in this PR, the `async` is renamed to `waitForAsync` and also deprecate `async`.
PR Close #37583
55 lines
1.5 KiB
TypeScript
55 lines
1.5 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright Google LLC 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 {asyncFallback} from './async_fallback';
|
|
|
|
/**
|
|
* Wraps a test function in an asynchronous test zone. The test will automatically
|
|
* complete when all asynchronous calls within this zone are done. Can be used
|
|
* to wrap an {@link inject} call.
|
|
*
|
|
* Example:
|
|
*
|
|
* ```
|
|
* it('...', waitForAsync(inject([AClass], (object) => {
|
|
* object.doSomething.then(() => {
|
|
* expect(...);
|
|
* })
|
|
* });
|
|
* ```
|
|
*
|
|
* @publicApi
|
|
*/
|
|
export function waitForAsync(fn: Function): (done: any) => any {
|
|
const _Zone: any = typeof Zone !== 'undefined' ? Zone : null;
|
|
if (!_Zone) {
|
|
return function() {
|
|
return Promise.reject(
|
|
'Zone is needed for the waitForAsync() test helper but could not be found. ' +
|
|
'Please make sure that your environment includes zone.js/dist/zone.js');
|
|
};
|
|
}
|
|
const asyncTest = _Zone && _Zone[_Zone.__symbol__('asyncTest')];
|
|
if (typeof asyncTest === 'function') {
|
|
return asyncTest(fn);
|
|
}
|
|
// not using new version of zone.js
|
|
// TODO @JiaLiPassion, remove this after all library updated to
|
|
// newest version of zone.js(0.8.25)
|
|
return asyncFallback(fn);
|
|
}
|
|
|
|
/**
|
|
* @deprecated use `waitForAsync()`, (expected removal in v12)
|
|
* @see {@link waitForAsync}
|
|
* @publicApi
|
|
* */
|
|
export function async(fn: Function): (done: any) => any {
|
|
return waitForAsync(fn);
|
|
}
|