@wollybeard/kit

Appearance

Num.NonNegative ​

Num / NonNegative

Import ​

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

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

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

Functions ​

[F] is ​

typescript
(value: unknown): boolean
Source

Type predicate to check if value is non-negative (= 0).

[F] from ​

typescript
(value: number): NonNegative
Source

Construct a NonNegative number. Throws if the value is negative.

[F] tryFrom ​

typescript
(value: number): NonNegative | null
Source

Try to construct a NonNegative number. Returns null if the value is negative.

Types ​

[∩] NonNegative ​

typescript
type NonNegative = number & { [NonNegativeBrand]: true }
Source

Non-negative number (= 0).