docs(portal): update return types (#11828)

Fixes the wrong return types being listed in the portal docs.

Fixes #11825.
This commit is contained in:
Kristiyan Kostadinov
2018-06-18 18:11:55 +02:00
committed by Jeremy Elbourn
parent 48dda505f7
commit 6b7196b425
+11 -11
View File
@@ -10,19 +10,19 @@ Portals and PortalOutlets are low-level building blocks that other concepts, suc
built upon.
##### `Portal<T>`
| Method | Description |
| --- | --- |
| `attach(PortalOutlet): Promise<T>` | Attaches the portal to a host. |
| `detach(): Promise<void>` | Detaches the portal from its host. |
| `isAttached: boolean` | Whether the portal is attached. |
| Method | Description |
| --------------------------- | ----------------------------------- |
| `attach(PortalOutlet): T` | Attaches the portal to a host. |
| `detach(): void` | Detaches the portal from its host. |
| `isAttached: boolean` | Whether the portal is attached. |
##### `PortalOutlet`
| Method | Description |
| --- | --- |
| `attach(Portal): Promise<void>` | Attaches a portal to the host. |
| `detach(): Promise<void>` | Detaches the portal from the host. |
| `dispose(): Promise<void>` | Permanently dispose the host. |
| `hasAttached: boolean` | Whether a portal is attached to the host. |
| Method | Description |
| ----------------------- | ------------------------------------------- |
| `attach(Portal): any` | Attaches a portal to the host. |
| `detach(): any` | Detaches the portal from the host. |
| `dispose(): void` | Permanently dispose the host. |
| `hasAttached: boolean` | Whether a portal is attached to the host. |
#### Portals in practice