(that: number): (self: number) => number
(self: number, that: number): numberDivides two number values without returning an Option.
When to use
Use to divide number values where the divisor is known to be non-zero and
a plain number result is preferred over handling Option.none.
Gotchas
Throws a RangeError if the divisor is 0.
Example (Dividing numbers unsafely)
import { Number } from "effect"
console.log(Number.divideUnsafe(6, 3)) // 2
// Passing 0 as the divisor throws a RangeError("Division by zero").export const const divideUnsafe: {
(that: number): (self: number) => number
(self: number, that: number): number
}
Divides two number values without returning an Option.
When to use
Use to divide number values where the divisor is known to be non-zero and
a plain number result is preferred over handling Option.none.
Gotchas
Throws a RangeError if the divisor is 0.
Example (Dividing numbers unsafely)
import { Number } from "effect"
console.log(Number.divideUnsafe(6, 3)) // 2
// Passing 0 as the divisor throws a RangeError("Division by zero").
divideUnsafe: {
(that: numberthat: number): (self: numberself: number) => number
(self: numberself: number, that: numberthat: number): number
} = dual<(...args: Array<any>) => any, (self: number, that: number) => number>(arity: 2, body: (self: number, that: number) => number): ((...args: Array<any>) => any) & ((self: number, that: number) => number) (+1 overload)Creates a function that can be called in data-first style or data-last
(pipe-friendly) style.
When to use
Use to expose one implementation through both direct and pipe-friendly
call styles.
Details
Pass either the arity of the uncurried function or a predicate that decides
whether the current call is data-first. Arity is the common case. Use a
predicate when optional arguments make arity ambiguous.
Example (Selecting data-first or data-last style by arity)
import { Function, pipe } from "effect"
const sum = Function.dual<
(that: number) => (self: number) => number,
(self: number, that: number) => number
>(2, (self, that) => self + that)
console.log(sum(2, 3)) // 5
console.log(pipe(2, sum(3))) // 5
Example (Defining overloads with call signatures)
import { Function, pipe } from "effect"
const sum: {
(that: number): (self: number) => number
(self: number, that: number): number
} = Function.dual(2, (self: number, that: number): number => self + that)
console.log(sum(2, 3)) // 5
console.log(pipe(2, sum(3))) // 5
Example (Selecting data-first or data-last style with a predicate)
import { Function, pipe } from "effect"
const sum = Function.dual<
(that: number) => (self: number) => number,
(self: number, that: number) => number
>(
(args) => args.length === 2,
(self, that) => self + that
)
console.log(sum(2, 3)) // 5
console.log(pipe(2, sum(3))) // 5
dual(
2,
(self: numberself: number, that: numberthat: number): number =>
import OptionOption.const getOrThrowWith: {
(onNone: () => unknown): <A>(
self: Option<A>
) => A
<A>(self: Option<A>, onNone: () => unknown): A
}
const divide: {
(that: number): (
self: number
) => Option.Option<number>
(
self: number,
that: number
): Option.Option<number>
}
self: numberself, that: numberthat), () => new var RangeError: RangeErrorConstructor
new (message?: string, options?: ErrorOptions) => RangeError (+3 overloads)