Skip to content

Commit

Permalink
feat(core): rename async to waitForAsync to avoid confusing (#37583)
Browse files Browse the repository at this point in the history
@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
  • Loading branch information
JiaLiPassion authored and alxhub committed Aug 3, 2020
1 parent e49b053 commit 8f07429
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions packages/core/testing/src/async.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import {asyncFallback} from './async_fallback';
* Example:
*
* ```
* it('...', async(inject([AClass], (object) => {
* it('...', waitForAsync(inject([AClass], (object) => {
* object.doSomething.then(() => {
* expect(...);
* })
Expand All @@ -25,12 +25,12 @@ import {asyncFallback} from './async_fallback';
*
* @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;
if (!_Zone) {
return function() {
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');
};
}
Expand All @@ -43,3 +43,12 @@ export function async(fn: Function): (done: any) => any {
// 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);
}

0 comments on commit 8f07429

Please sign in to comment.