https://github.com/anvell/async
Type describing generic asynchronous value
https://github.com/anvell/async
async datatype kotlin mvi-android mvi-architecture
Last synced: 9 months ago
JSON representation
Type describing generic asynchronous value
- Host: GitHub
- URL: https://github.com/anvell/async
- Owner: Anvell
- License: mit
- Created: 2021-04-07T10:23:46.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-17T21:22:19.000Z (almost 2 years ago)
- Last Synced: 2025-03-28T01:49:36.415Z (about 1 year ago)
- Topics: async, datatype, kotlin, mvi-android, mvi-architecture
- Language: Kotlin
- Homepage: https://anvell.github.io/async
- Size: 208 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Async
[](https://jitpack.io/#anvell/async)
[](https://github.com/anvell/async/blob/master/LICENSE)
![badge][badge-jvm]
![badge][badge-js]
![badge][badge-linux]
![badge][badge-windows]
![badge][badge-mac]
![badge][badge-ios]
Type describing generic asynchronous value.
Async value can be in either of the following states:
• `Uninitialized` - the value has not been initialized yet
• `Loading` - the value is being loaded
• `Success` - stores successfully loaded `value`
• `Fail` - failed to load the value with `error`
## Installation
Library is published on jitpack.io. Add repository it to your ```build.gradle``` script:
```gradle
allprojects {
repositories {
maven { url 'https://jitpack.io' }
}
}
```
and:
```gradle
dependencies {
implementation 'com.github.anvell:async:1.2.0'
}
```
## API Reference
In order to generate API Reference in `.html` format, run the following command:
```shell
$ ./gradlew dokkaHtmlMultiModule
```
## Licensing
Project is available under [MIT](https://github.com/Anvell/async/blob/master/LICENSE.txt) License.
[badge-jvm]: http://img.shields.io/badge/-JVM-DB413D.svg?style=flat-square
[badge-js]: http://img.shields.io/badge/-JS-F8DB5D.svg?style=flat-square
[badge-linux]: http://img.shields.io/badge/-Linux-2D3F6C.svg?style=flat-square
[badge-windows]: http://img.shields.io/badge/-Windows-4D76CD.svg?style=flat-square
[badge-ios]: http://img.shields.io/badge/-iOS-CDCDCD.svg?style=flat-square
[badge-mac]: http://img.shields.io/badge/-MacOs-808080.svg?style=flat-square