iSharkFly-Docs
/
angular-docs-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat(core): rename async to waitForAsync to avoid confusing (#37583) 

@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
This commit is contained in:
JiaLiPassion 2020-08-01 04:43:05 +09:00 committed by Alex Rickabaugh
parent e49b053dac
commit 8f074296c2
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
packages/core/testing/src/async.ts
View File

@ -16,7 +16,7 @@ import {asyncFallback} from './async_fallback';
* Example: * Example:
* *
* ``` * ```
* it('...', async(inject([AClass], (object) => { * it('...', waitForAsync(inject([AClass], (object) => {
* object.doSomething.then(() => { * object.doSomething.then(() => {
* expect(...); * expect(...);
* }) * })
@ -25,12 +25,12 @@ import {asyncFallback} from './async_fallback';
* *
* @publicApi * @publicApi
*/ */
export function async(fn: Function): (done: any) => any { export function waitForAsync(fn: Function): (done: any) => any {
const _Zone: any = typeof Zone !== 'undefined' ? Zone : null; const _Zone: any = typeof Zone !== 'undefined' ? Zone : null;
if (!_Zone) { if (!_Zone) {
return function() { return function() {
return Promise.reject( return Promise.reject(
'Zone is needed for the async() test helper but could not be found. ' + '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'); 'Please make sure that your environment includes zone.js/dist/zone.js');
}; };
} }
@ -43,3 +43,12 @@ export function async(fn: Function): (done: any) => any {
// newest version of zone.js(0.8.25) // newest version of zone.js(0.8.25)
return asyncFallback(fn); 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);
}