effect 3.1.0 → 3.1.2

package/src/Iterable.ts

@@ -24,7 +24,7 @@ import type { NoInfer } from "./Types.js"
  * **Note**. `length` is normalized to an integer >= 1.
  *
  * @example
- * import { makeBy } from 'effect/Iterable'
+ * import { makeBy } from "effect/Iterable"
  *
  * assert.deepStrictEqual(Array.from(makeBy(n => n * 2, { length: 5 })), [0, 2, 4, 6, 8])
  *
@@ -56,7 +56,7 @@ export const makeBy = <A>(f: (i: number) => A, options?: {
  * If `end` is omitted, the range will not have an upper bound.
  *
  * @example
- * import { range } from 'effect/Iterable'
+ * import { range } from "effect/Iterable"
  *
  * assert.deepStrictEqual(Array.from(range(1, 3)), [1, 2, 3])
  *
@@ -78,7 +78,7 @@ export const range = (start: number, end?: number): Iterable<number> => {
  * **Note**. `n` is normalized to an integer >= 1.
  *
  * @example
- * import { replicate } from 'effect/Iterable'
+ * import { replicate } from "effect/Iterable"
  *
  * assert.deepStrictEqual(Array.from(replicate("a", 3)), ["a", "a", "a"])
  *
@@ -129,7 +129,7 @@ export const prepend: {
  * Prepends the specified prefix iterable to the beginning of the specified iterable.
  *
  * @example
- * import * as Iterable from "effect/Iterable"
+ * import { Iterable } from "effect"
  *
  * assert.deepStrictEqual(
  *   Array.from(Iterable.prependAll([1, 2], ["a", "b"])),
@@ -806,11 +806,10 @@ export const filterMapWhile: {
  * Retrieves the `Some` values from an `Iterable` of `Option`s.
  *
  * @example
- * import { getSomes } from "effect/Iterable"
- * import { some, none } from "effect/Option"
+ * import { Iterable, Option } from "effect"
  *
  * assert.deepStrictEqual(
- *   Array.from(getSomes([some(1), none(), some(2)])),
+ *   Array.from(Iterable.getSomes([Option.some(1), Option.none(), Option.some(2)])),
  *   [1, 2]
  * )
  *
@@ -823,11 +822,10 @@ export const getSomes: <A>(self: Iterable<Option<A>>) => Iterable<A> = filterMap
  * Retrieves the `Left` values from an `Iterable` of `Either`s.
  *
  * @example
- * import { getLefts } from "effect/Iterable"
- * import { right, left } from "effect/Either"
+ * import { Iterable, Either } from "effect"
  *
  * assert.deepStrictEqual(
- *   Array.from(getLefts([right(1), left("err"), right(2)])),
+ *   Array.from(Iterable.getLefts([Either.right(1), Either.left("err"), Either.right(2)])),
  *   ["err"]
  * )
  *
@@ -840,11 +838,10 @@ export const getLefts = <R, L>(self: Iterable<Either<R, L>>): Iterable<L> => fil
  * Retrieves the `Right` values from an `Iterable` of `Either`s.
  *
  * @example
- * import { getRights } from "effect/Iterable"
- * import { right, left } from "effect/Either"
+ * import { Iterable, Either } from "effect"
  *
  * assert.deepStrictEqual(
- *   Array.from(getRights([right(1), left("err"), right(2)])),
+ *   Array.from(Iterable.getRights([Either.right(1), Either.left("err"), Either.right(2)])),
  *   [1, 2]
  * )
  *

package/src/List.ts

@@ -324,7 +324,7 @@ export const append: {
  * If either list is non-empty, the result is also a non-empty list.
  *
  * @example
- * import * as List from "effect/List"
+ * import { List } from "effect"
  *
  * assert.deepStrictEqual(
  *   List.make(1, 2).pipe(List.appendAll(List.make("a", "b")), List.toArray),
@@ -357,7 +357,7 @@ export const prepend: {
  * If either list is non-empty, the result is also a non-empty list.
  *
  * @example
- * import * as List from "effect/List"
+ * import { List } from "effect"
  *
  * assert.deepStrictEqual(
  *   List.make(1, 2).pipe(List.prependAll(List.make("a", "b")), List.toArray),

package/src/Metric.ts

@@ -165,7 +165,7 @@ export const mapInput: {
  * - incremental - Set to 'true' for a counter that only increases. With this configuration, Effect ensures that non-incremental updates have no impact on the counter, making it exclusively suitable for counting upwards.
  *
  * @example
- * import * as Metric from "effect/Metric"
+ * import { Metric } from "effect"
  *
  * const numberCounter = Metric.counter("count", {
  *   description: "A number counter"
@@ -206,7 +206,7 @@ export const counter: {
  * @param description - An optional description of the Frequency metric.
  *
  * @example
- * import * as Metric from "effect/Metric"
+ * import { Metric } from "effect"
  *
  * const errorFrequency = Metric.frequency("error_frequency", {
  *    description: "Counts the occurrences of errors."
@@ -254,7 +254,7 @@ export const fromMetricKey: <Type extends MetricKeyType.MetricKeyType<any, any>>
  * - bigint - Indicates if the counter uses 'bigint' data type.
  *
  * @example
- * import * as Metric from "effect/Metric"
+ * import { Metric } from "effect"
  *
  * const numberGauge = Metric.gauge("memory_usage", {
  *   description: "A gauge for memory usage"
@@ -288,8 +288,7 @@ export const gauge: {
  * @param description - A description of the histogram metric.
  *
  * @example
- * import * as Metric from "effect/Metric"
- * import * as MetricBoundaries from "effect/MetricBoundaries"
+ * import { Metric, MetricBoundaries } from "effect"
  *
  * const latencyHistogram = Metric.histogram("latency_histogram",
  *   MetricBoundaries.linear({ start: 0, width: 10, count: 11 }),
@@ -393,8 +392,7 @@ export const sync: <Out>(evaluate: LazyArg<Out>) => Metric<void, unknown, Out> =
  * - description - An optional description of the Summary metric.
  *
  * @example
- * import * as Metric from "effect/Metric"
- * import * as Chunk from "effect/Chunk"
+ * import { Metric, Chunk } from "effect"
  *
  * const responseTimesSummary = Metric.summary({
  *   name: "response_times_summary",

package/src/Number.ts

@@ -19,7 +19,7 @@ import * as predicate from "./Predicate.js"
  * @param input - The value to test.
  *
  * @example
- * import { isNumber } from 'effect/Number'
+ * import { isNumber } from "effect/Number"
  *
  * assert.deepStrictEqual(isNumber(2), true)
  * assert.deepStrictEqual(isNumber("2"), false)
@@ -36,7 +36,7 @@ export const isNumber: (input: unknown) => input is number = predicate.isNumber
  * @param that - The second operand.
  *
  * @example
- * import { sum } from 'effect/Number'
+ * import { sum } from "effect/Number"
  *
  * assert.deepStrictEqual(sum(2, 3), 5)
  *
@@ -55,7 +55,7 @@ export const sum: {
  * @param that - The second operand.
  *
  * @example
- * import { multiply } from 'effect/Number'
+ * import { multiply } from "effect/Number"
  *
  * assert.deepStrictEqual(multiply(2, 3), 6)
  *
@@ -74,7 +74,7 @@ export const multiply: {
  * @param that - The second operand.
  *
  * @example
- * import { subtract } from 'effect/Number'
+ * import { subtract } from "effect/Number"
  *
  * assert.deepStrictEqual(subtract(2, 3), -1)
  *
@@ -93,11 +93,10 @@ export const subtract: {
  * @param that - The divisor operand.
  *
  * @example
- * import { divide } from 'effect/Number'
- * import { some, none } from 'effect/Option'
+ * import { Number, Option } from "effect"
  *
- * assert.deepStrictEqual(divide(6, 3), some(2))
- * assert.deepStrictEqual(divide(6, 0), none())
+ * assert.deepStrictEqual(Number.divide(6, 3), Option.some(2))
+ * assert.deepStrictEqual(Number.divide(6, 0), Option.none())
  *
  * @category math
  * @since 2.0.0
@@ -119,7 +118,7 @@ export const divide: {
  * @param that - The divisor operand.
  *
  * @example
- * import { unsafeDivide } from 'effect/Number'
+ * import { unsafeDivide } from "effect/Number"
  *
  * assert.deepStrictEqual(unsafeDivide(6, 3), 2)
  *
@@ -137,7 +136,7 @@ export const unsafeDivide: {
  * @param n - A `number` to be incremented.
  *
  * @example
- * import { increment } from 'effect/Number'
+ * import { increment } from "effect/Number"
  *
  * assert.deepStrictEqual(increment(2), 3)
  *
@@ -152,7 +151,7 @@ export const increment = (n: number): number => n + 1
  * @param n - A `number` to be decremented.
  *
  * @example
- * import { decrement } from 'effect/Number'
+ * import { decrement } from "effect/Number"
  *
  * assert.deepStrictEqual(decrement(3), 2)
  *
@@ -180,7 +179,7 @@ export const Order: order.Order<number> = order.number
  * @param that - The second argument.
  *
  * @example
- * import { lessThan } from 'effect/Number'
+ * import { lessThan } from "effect/Number"
  *
  * assert.deepStrictEqual(lessThan(2, 3), true)
  * assert.deepStrictEqual(lessThan(3, 3), false)
@@ -201,7 +200,7 @@ export const lessThan: {
  * @param that - The second `number` to compare with.
  *
  * @example
- * import { lessThanOrEqualTo } from 'effect/Number'
+ * import { lessThanOrEqualTo } from "effect/Number"
  *
  * assert.deepStrictEqual(lessThanOrEqualTo(2, 3), true)
  * assert.deepStrictEqual(lessThanOrEqualTo(3, 3), true)
@@ -222,7 +221,7 @@ export const lessThanOrEqualTo: {
  * @param that - The second argument.
  *
  * @example
- * import { greaterThan } from 'effect/Number'
+ * import { greaterThan } from "effect/Number"
  *
  * assert.deepStrictEqual(greaterThan(2, 3), false)
  * assert.deepStrictEqual(greaterThan(3, 3), false)
@@ -243,7 +242,7 @@ export const greaterThan: {
  * @param that - The second `number` to compare with.
  *
  * @example
- * import { greaterThanOrEqualTo } from 'effect/Number'
+ * import { greaterThanOrEqualTo } from "effect/Number"
  *
  * assert.deepStrictEqual(greaterThanOrEqualTo(2, 3), false)
  * assert.deepStrictEqual(greaterThanOrEqualTo(3, 3), true)
@@ -265,7 +264,7 @@ export const greaterThanOrEqualTo: {
  * @param maximum - The `maximum` value to check.
  *
  * @example
- * import * as Number from 'effect/Number'
+ * import { Number } from "effect"
  *
  * const between = Number.between({ minimum: 0, maximum: 5 })
  *
@@ -299,7 +298,7 @@ export const between: {
  * @param maximum - The upper end of the range.
  *
  * @example
- * import * as Number from 'effect/Number'
+ * import { Number } from "effect"
  *
  * const clamp = Number.clamp({ minimum: 1, maximum: 5 })
  *
@@ -327,7 +326,7 @@ export const clamp: {
  * @param that - The second `number`.
  *
  * @example
- * import { min } from 'effect/Number'
+ * import { min } from "effect/Number"
  *
  * assert.deepStrictEqual(min(2, 3), 2)
  *
@@ -345,7 +344,7 @@ export const min: {
  * @param that - The second `number`.
  *
  * @example
- * import { max } from 'effect/Number'
+ * import { max } from "effect/Number"
  *
  * assert.deepStrictEqual(max(2, 3), 3)
  *
@@ -362,7 +361,7 @@ export const max: {
  * @param n - The `number` to determine the sign of.
  *
  * @example
- * import { sign } from 'effect/Number'
+ * import { sign } from "effect/Number"
  *
  * assert.deepStrictEqual(sign(-5), -1)
  * assert.deepStrictEqual(sign(0), 0)
@@ -379,7 +378,7 @@ export const sign = (n: number): Ordering => Order(n, 0)
  * @param collection - The collection of `number`s to sum.
  *
  * @example
- * import { sumAll } from 'effect/Number'
+ * import { sumAll } from "effect/Number"
  *
  * assert.deepStrictEqual(sumAll([2, 3, 4]), 9)
  *