CDK documentation wrong [Portal]

[djleonskennedy]

Bug, feature request, or proposal:

Bug

What is the expected behavior?

attach(), detach() should return a Promise

What is the current behavior?

attach(), detach() do not return a Promise

What are the steps to reproduce?

Providing a StackBlitz reproduction is the best way to share your issue.

According to documentation attach(), detach() return a Promise

https://stackblitz.com/edit/angular-cdk-portal-template-ygs7q1?file=app/app.component.ts

throws error: ERROR TypeError: this.portalHost.attach(...).then is not a function

What is the use-case or motivation for changing an existing behavior?

We have behavior that requires as to run mechanism only when component is attached

Which versions of Angular, Material, OS, TypeScript, browsers are affected?

angular, material 6.x.x

Is there anything else we should know?

[crisbeto]

I've submitted a PR to fix the docs. Since attaching the portals is synchronous, you can do your extra work after attach is called.

[djleonskennedy]

@crisbeto thank you

[angular-automatic-lock-bot]

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{This action has been performed automatically by a bot.}