kotools/types

✨ New `orNull(Double)` and `orThrow(Double)` in `Zero.Companion`

LVMVRQUXL opened this issue · 0 comments

📝 Description

We want to add experimental overloads for the Zero.Companion.orNull and the Zero.Companion.orThrow methods, for creating an instance of the Zero type from the specified Double number.

Here's the Application Programming Interface (API) goal of this issue:

interface Zero {
    companion object {
        fun orNull(number: Double): Zero?
        fun orThrow(number: Double): Zero
    }
}

These factory methods should be available for all platforms, except for the orNull method that shouldn't be accessible from Java, due to its non-explicit support for nullable types.

✅ Checklist

See the Issue implementation section in the contributing guidelines before addressing the following checklist.

  • ✨ Add the orThrow(Double) method for Kotlin and Java with tests, documentation and samples.
  • ✨ Add the orNull(Double) method only for Kotlin with tests, documentation and samples.
  • 📝 Update the unreleased changelog for this issue.