effect-io-ai

Package: effect
Module: Number

Number.remainder

Returns the remainder left over when one operand is divided by a second operand.

It always takes the sign of the dividend.

Example

import * as assert from "node:assert/strict"
import { remainder } from "effect/Number"

assert.equal(remainder(2, 2), 0)
assert.equal(remainder(3, 2), 1)
assert.equal(remainder(-4, 2), -0)

Signature

declare const remainder: { (divisor: number): (dividend: number) => number; (dividend: number, divisor: number): number; }

Source

Since v2.0.0