effect-io-ai

Package: effect
Module: Number

Number.remainder

Returns the remainder left over when one operand is divided by a second operand, always taking the sign of the dividend.

When to use

Use to compute a numeric remainder while preserving decimal precision better than direct JavaScript % for decimal operands.

Example (Calculating remainders)

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

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

See

• divide for quotient calculation with division-by-zero represented as Option.none

Signature

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

Source

Since v2.0.0