@wollybeard/kit

Appearance

Num.Percentage ​

Num / Percentage

Import ​

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

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

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

Functions ​

[F] is ​

typescript
(value: unknown): boolean
Source

Type predicate for percentage (0-1).

[F] from ​

typescript
(value: number): Percentage
Source

Construct a Percentage. Throws if the value is not between 0 and 1.

[F] tryFrom ​

typescript
(value: number): Percentage | null
Source

Try to construct a Percentage. Returns null if the value is not between 0 and 1.

[F] fromPercent ​

typescript
(value: number): Percentage
Source

Convert a percentage value (0-100) to a decimal (0-1).

[F] toPercent ​

typescript
(value: Percentage): number
Source

Convert a decimal (0-1) to a percentage value (0-100).

[F] clamp ​

typescript
(value: number): Percentage
Source

Clamp a value to percentage range (0-1).

Types ​

[∩] Percentage ​

typescript
type Percentage = InRange<0, 1> & { [PercentageBrand]: true }
Source

Percentage (0-1). Represents a value between 0% (0.0) and 100% (1.0).