Skip to content

Num.Zero

Num / Zero

Import

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

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

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

Functions

[F] is

typescript
(value: unknown): boolean

Type predicate to check if value is zero.

[F] from

typescript
(value: number): Zero

Construct a Zero. Throws if the value is not zero.

[F] tryFrom

typescript
(value: number): Zero | null

Try to construct a Zero. Returns null if the value is not zero.

Constants

[C] ZERO

typescript
Zero

The zero constant.

Types

[∩] Zero

typescript
type Zero = 0 & { [ZeroBrand]: true }

Zero.