@wollybeard/kit

Appearance

Num.NonPositive ​

Num / NonPositive

Import ​

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

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

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

Functions ​

[F] is ​

typescript
(value: unknown): boolean
Source

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

[F] from ​

typescript
(value: number): NonPositive
Source

Construct a NonPositive number. Throws if the value is positive.

[F] tryFrom ​

typescript
(value: number): NonPositive | null
Source

Try to construct a NonPositive number. Returns null if the value is positive.

Types ​

[∩] NonPositive ​

typescript
type NonPositive = number & { [NonPositiveBrand]: true }
Source

Non-positive number (= 0).