Mod | /typical/num.ts | rimbu@1.0.2

The Deno 2 Release Candidate is here

Rimbu is a TypeScript library focused on immutable, performant, and type-safe collections and other tools.

type alias Mod

import { type Mod } from "https://deno.land/x/rimbu@1.0.2/typical/num.ts";

Returns the remainder after dividing the first given natural number by the second.

Examples

Example 1

Mod<0, 0> => never
Mod<9, 3> => 0
Mod<14, 5> => 4

Type Parameters

N1 extends number

N2 extends number

definition: N2 extends 0 ? never : N1 extends 0 ? 0 : N1 extends N2 ? 0 : StrNum.ToNumber<StrNum.Divide<StrNum.FromNumber<N1>, StrNum.FromNumber<N2>>[1]>