@wollybeard/kit

Appearance

Num.Float ​

Num / Float

Import ​

typescript
import { Num } from '@wollybeard/kit'

// Access via namespace
Num.Float.someFunction()
typescript
import * as Num from '@wollybeard/kit/num'

// Access via namespace
Num.Float.someFunction()

Functions ​

[F] is ​

typescript
(value: unknown): boolean
Source

Type predicate to check if value is a float (non-integer number).

[F] from ​

typescript
(value: number): number & { [FloatBrand]: true; } & { [FiniteBrand]: true; }
Source

Construct a Float. Throws if the value is not a float.

[F] tryFrom ​

typescript
(value: number): (number & { [FloatBrand]: true; } & { [FiniteBrand]: true; }) | null
Source

Try to construct a Float. Returns null if the value is not a float.

[F] toFloat ​

typescript
(value: number): number & { [FloatBrand]: true; } & { [FiniteBrand]: true; }
Source

Convert an integer to a float by adding a small decimal.

Types ​

[∩] Float ​

typescript
type Float = number & { [FloatBrand]: true }
Source

Float (non-integer finite number).