Function BoundedNumber

BoundedNumber(
    brand: string,
    min: number,
    max: number,
): ValidatedBrand<string, number>

Create a number brand with min/max bounds

Parameters

brand: string
min: number
max: number

Returns ValidatedBrand<string, number>

Example

const Percentage = BoundedNumber("Percentage", 0, 100)
const valid = Percentage.of(75) // Some(Brand<"Percentage", number>)
const invalid = Percentage.of(150) // None

Example

const Port = BoundedNumber("Port", 1, 65535)
const httpPort = Port.unsafeOf(80) // Brand<"Port", number>
// Port.unsafeOf(70000) // throws Error