/kmmutils

A collection of everything missing from the Kotlin Multiplatform Standard Library

Primary LanguageKotlinApache License 2.0Apache-2.0

KMM Utilities

CI Docs CodeFactor GitHub top language GitHub GitHub issues GitHub last commit AndroidWeekly #556

KMM Utils is a collection of all the things that are missing from Kotlin STL, popular KMM libraries & platform SDKs. The library is meant to be a drop-in dependency - no need to study anything - just add and enjoy the expanded API of the things you are used to, relying on autocompletion to come up with suggestions for you.

See documentation at https://opensource.respawn.pro/kmmutils/ Javadocs are at /kmmutils/javadocs

Features

  • ApiResult: A monad for wrapping operations that may fail. Similar to kotlin.Result, but offers extensive, clean DSL and better performance.
  • InputForms: A stateful and composable text input field validation framework with clean DSL.
  • Common: Kotlin standard library extensions
  • Datetime: All the things missing from kotlinx.datetime and Java Calendar & DateTime API.
  • Coroutines: Things missing from Coroutines & Flows API.

Installation

Maven Central

[versions]
kmmutils = "< Badge above 👆🏻 >"

[dependencies]
kmmutils-apiresult = { module = "pro.respawn.kmmutils:apiresult", version.ref = "kmmutils" }
kmmutils-common = { module = "pro.respawn.kmmutils:common", version.ref = "kmmutils" }
kmmutils-datetime = { module = "pro.respawn.kmmutils:datetime", version.ref = "kmmutils" }
kmmutils-coroutines = { module = "pro.respawn.kmmutils:coroutines", version.ref = "kmmutils" }
kmmutils-inputforms = { module = "pro.respawn.kmmutils:inputforms", version.ref = "kmmutils" }

[bundles]
kmmutils = [
    "kmmutils-apiresult",
    "kmmutils-common",
    "kmmutils-datetime",
    "kmmutils-coroutines",
    "kmmutils-inputforms"
]

Supported platforms

  • Android [ SDK21+ ],
  • JVM [ 8+ ],
  • iOS [ x64, ArmX64, macOSx64, macOSArm64 ]
  • JS [ browser, node.js ]

License

Copyright 2022-2023 Respawn Team and contributors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.