FloatFromString overview

Added in v1.0.0

---

Table of contents

• Conversion
  • FloatFromString
• utils
  • FloatString (type alias)

---

Conversion

FloatFromString

Floating point branded newtype from strings. Parameters: min, max are inclusive.

Represents string floating point numbers:

 { f | f ∈ ℝ, f >= -Number.MAX_VALUE, f <= Number.MAX_VALUE }

Signature

export declare const FloatFromString: Schema<
  Opaque<string, FloatStringBrand<-1.7976931348623157e308, 1.7976931348623157e308>>,
  Opaque<number, FloatBrand<-1.7976931348623157e308, 1.7976931348623157e308>>
>

Added in v1.0.0

utils

FloatString (type alias)

A string that can safely be parsed to a floating point number.

Signature

export type FloatString<Min = MaxNegativeFloat, Max = MaxPositiveFloat> = Branded<string, FloatStringBrand<Min, Max>>

Added in v2.0.0