Skip to content

Commit

Permalink
Reorder functions documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
LouisCAD committed Apr 28, 2019
1 parent 86ec1c0 commit c977dd6
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions modules/lifecycle-coroutines/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,20 @@ Extension properties:

| **Name** | **Description**
| -------- | ---------------
| `Lifecycle.coroutineScope` | A scope that dispatches on Android Main thread and is active until the Lifecycle is destroyed.
| `LifecycleOwner.lifecycleScope` | A scope that dispatches on Android Main thread and is active until the LifecycleOwner is destroyed.
| `Lifecycle.coroutineScope` | A scope that dispatches on Android Main thread and is active until the Lifecycle is destroyed.
| `Lifecycle.job` | A job that is cancelled when the Lifecycle is destroyed.

Extension functions:

| **Name** | **Description**
| -------- | ---------------
| `Lifecycle.createJob` | A job that is active while the state is at least the passed one.
| `Lifecycle.createScope` | A scope that dispatches on Android Main thread and is active while the state is at least the passed one.
| `Lifecycle.awaitState` | A suspending function that returns/resumes as soon as the state of the Lifecycle is at least the passed state.
| `Lifecycle.awaitResumed` | A suspending function that returns/resumes as soon as the state of the Lifecycle is resumed.
| `Lifecycle.awaitStarted` | A suspending function that returns/resumes as soon as the state of the Lifecycle is at least started.
| `Lifecycle.awaitCreated` | A suspending function that returns/resumes as soon as the state of the Lifecycle is at least created.
| `Lifecycle.awaitState` | A suspending function that returns/resumes as soon as the state of the Lifecycle is at least the passed state.
| `Lifecycle.createJob` | A job that is active while the state is at least the passed one.
| `Lifecycle.createScope` | A scope that dispatches on Android Main thread and is active while the state is at least the passed one.

## Example

Expand Down

0 comments on commit c977dd6

Please sign in to comment.