effect 4.0.0-beta.83 → 4.0.0-beta.84

package/dist/Order.d.ts

@@ -15,7 +15,7 @@ import * as Reducer from "./Reducer.ts";
  * is greater than the second. It must satisfy total ordering laws: totality,
  * antisymmetry, and transitivity.
  *
- * **Example** (Custom Order)
+ * **Example** (Defining a custom Order)
  *
  * ```ts
  * import { Order } from "effect"
@@ -105,7 +105,7 @@ export declare function make<A>(compare: (self: A, that: A) => -1 | 0 | 1): Orde
  * Uses lexicographic dictionary ordering. The empty string is less than any
  * non-empty string, and comparisons are case-sensitive.
  *
- * **Example** (String Ordering)
+ * **Example** (Ordering strings)
  *
  * ```ts
  * import { Order } from "effect"
@@ -134,7 +134,7 @@ export declare const String: Order<string>;
  * each other, and any `NaN` is considered less than any non-`NaN` number. All
  * other values use standard numeric comparison.
  *
- * **Example** (Number Ordering)
+ * **Example** (Ordering numbers)
  *
  * ```ts
  * import { Order } from "effect"
@@ -164,7 +164,7 @@ export declare const Number: Order<number>;
  *
  * `false` is less than `true`, and equal values return `0`.
  *
- * **Example** (Boolean Ordering)
+ * **Example** (Ordering booleans)
  *
  * ```ts
  * import { Order } from "effect"
@@ -191,7 +191,7 @@ export declare const Boolean: Order<boolean>;
  * Uses standard numeric comparison for bigint values and handles arbitrarily
  * large integers.
  *
- * **Example** (BigInt Ordering)
+ * **Example** (Ordering BigInts)
  *
  * ```ts
  * import { Order } from "effect"
@@ -220,7 +220,7 @@ export declare const BigInt: Order<bigint>;
  * original order returns `-1`, the flipped order returns `1`, and vice versa.
  * Equal comparisons remain `0`.
  *
- * **Example** (Reversing Order)
+ * **Example** (Reversing an Order)
  *
  * ```ts
  * import { Order } from "effect"
@@ -251,7 +251,7 @@ export declare function flip<A>(O: Order<A>): Order<A>;
  * returned; otherwise, the second order is applied. The result is the first
  * non-zero comparison result, or `0` if both orders return `0`.
  *
- * **Example** (Combining Orders)
+ * **Example** (Combining two Orders)
  *
  * ```ts
  * import { Order } from "effect"
@@ -294,7 +294,7 @@ export declare const combine: {
      * returned; otherwise, the second order is applied. The result is the first
      * non-zero comparison result, or `0` if both orders return `0`.
      *
-     * **Example** (Combining Orders)
+     * **Example** (Combining two Orders)
      *
      * ```ts
      * import { Order } from "effect"
@@ -337,7 +337,7 @@ export declare const combine: {
      * returned; otherwise, the second order is applied. The result is the first
      * non-zero comparison result, or `0` if both orders return `0`.
      *
-     * **Example** (Combining Orders)
+     * **Example** (Combining two Orders)
      *
      * ```ts
      * import { Order } from "effect"
@@ -379,7 +379,7 @@ export declare const combine: {
  * Always returns `0` regardless of input values, making it useful as a neutral
  * element in order composition.
  *
- * **Example** (Always Equal Order)
+ * **Example** (Ordering with an always-equal Order)
  *
  * ```ts
  * import { Order } from "effect"
@@ -409,7 +409,7 @@ export declare function alwaysEqual<A>(): Order<A>;
  * Applies orders in iteration order and short-circuits on the first non-zero
  * result. It returns `0` only if all orders return `0`.
  *
- * **Example** (Combining Multiple Orders)
+ * **Example** (Combining multiple Orders)
  *
  * ```ts
  * import { Order } from "effect"
@@ -550,7 +550,7 @@ export declare const mapInput: {
  * Earlier dates are less than later dates. Invalid dates are compared through
  * their `getTime()` result.
  *
- * **Example** (Date Ordering)
+ * **Example** (Ordering Dates)
  *
  * ```ts
  * import { Order } from "effect"
@@ -581,7 +581,7 @@ export declare const Date: Order<Date>;
  * the first non-zero comparison result. Tuples must have the same length as the
  * order collection, and the result is `0` only if all elements are equal.
  *
- * **Example** (Tuple Ordering)
+ * **Example** (Ordering tuples)
  *
  * ```ts
  * import { Order } from "effect"
@@ -619,7 +619,7 @@ export {
  * are less than longer arrays. The result is `0` only if arrays have the same
  * length and all elements are equal.
  *
- * **Example** (Array Element Ordering)
+ * **Example** (Ordering array elements)
  *
  * ```ts
  * import { Order } from "effect"
@@ -650,7 +650,7 @@ Array_ as Array };
  * stops at the first non-zero comparison result. Field order matters: earlier
  * fields take precedence. The result is `0` only if all fields are equal.
  *
- * **Example** (Struct Ordering)
+ * **Example** (Ordering structs)
  *
  * ```ts
  * import { Order } from "effect"
@@ -691,7 +691,7 @@ export declare function Struct<const R extends {
  * Returns `true` if the order returns `-1`, meaning the first value is less
  * than the second. Equal or greater values return `false`.
  *
- * **Example** (Less Than)
+ * **Example** (Checking less-than comparisons)
  *
  * ```ts
  * import { Order } from "effect"
@@ -724,7 +724,7 @@ export declare const isLessThan: <A>(O: Order<A>) => {
  * Returns `true` if the order returns `1`, meaning the first value is greater
  * than the second. Equal or lesser values return `false`.
  *
- * **Example** (Greater Than)
+ * **Example** (Checking greater-than comparisons)
  *
  * ```ts
  * import { Order } from "effect"
@@ -757,7 +757,7 @@ export declare const isGreaterThan: <A>(O: Order<A>) => {
  * Returns `true` if the order returns `-1` or `0`, and returns `false` only if
  * the order returns `1`.
  *
- * **Example** (Less Than Or Equal)
+ * **Example** (Checking less-than-or-equal comparisons)
  *
  * ```ts
  * import { Order } from "effect"
@@ -791,7 +791,7 @@ export declare const isLessThanOrEqualTo: <A>(O: Order<A>) => {
  * Returns `true` if the order returns `1` or `0`, and returns `false` only if
  * the order returns `-1`.
  *
- * **Example** (Greater Than Or Equal)
+ * **Example** (Checking greater-than-or-equal comparisons)
  *
  * ```ts
  * import { Order } from "effect"
@@ -825,7 +825,7 @@ export declare const isGreaterThanOrEqualTo: <A>(O: Order<A>) => {
  * Returns the value that compares as less than or equal to the other value. If
  * values are equal, the first argument is returned.
  *
- * **Example** (Minimum Value)
+ * **Example** (Selecting the minimum value)
  *
  * ```ts
  * import { Order } from "effect"
@@ -859,7 +859,7 @@ export declare const min: <A>(O: Order<A>) => {
  * Returns the value that compares as greater than or equal to the other value.
  * If values are equal, the first argument is returned.
  *
- * **Example** (Maximum Value)
+ * **Example** (Selecting the maximum value)
  *
  * ```ts
  * import { Order } from "effect"
@@ -895,7 +895,7 @@ export declare const max: <A>(O: Order<A>) => {
  * maximum. The minimum must be less than or equal to the maximum according to
  * the order.
  *
- * **Example** (Clamping Values)
+ * **Example** (Clamping values)
  *
  * ```ts
  * import { Order } from "effect"
@@ -938,7 +938,7 @@ export declare const clamp: <A>(O: Order<A>) => {
  * than or equal to maximum. Values outside the range return `false`. Both
  * bounds are inclusive.
  *
- * **Example** (Checking Range)
+ * **Example** (Checking ranges)
  *
  * ```ts
  * import { Order } from "effect"

package/dist/Order.js

@@ -62,7 +62,7 @@ export function make(compare) {
  * Uses lexicographic dictionary ordering. The empty string is less than any
  * non-empty string, and comparisons are case-sensitive.
  *
- * **Example** (String Ordering)
+ * **Example** (Ordering strings)
  *
  * ```ts
  * import { Order } from "effect"
@@ -91,7 +91,7 @@ export const String = /*#__PURE__*/make((self, that) => self < that ? -1 : 1);
  * each other, and any `NaN` is considered less than any non-`NaN` number. All
  * other values use standard numeric comparison.
  *
- * **Example** (Number Ordering)
+ * **Example** (Ordering numbers)
  *
  * ```ts
  * import { Order } from "effect"
@@ -126,7 +126,7 @@ export const Number = /*#__PURE__*/make((self, that) => {
  *
  * `false` is less than `true`, and equal values return `0`.
  *
- * **Example** (Boolean Ordering)
+ * **Example** (Ordering booleans)
  *
  * ```ts
  * import { Order } from "effect"
@@ -153,7 +153,7 @@ export const Boolean = /*#__PURE__*/make((self, that) => self < that ? -1 : 1);
  * Uses standard numeric comparison for bigint values and handles arbitrarily
  * large integers.
  *
- * **Example** (BigInt Ordering)
+ * **Example** (Ordering BigInts)
  *
  * ```ts
  * import { Order } from "effect"
@@ -182,7 +182,7 @@ export const BigInt = /*#__PURE__*/make((self, that) => self < that ? -1 : 1);
  * original order returns `-1`, the flipped order returns `1`, and vice versa.
  * Equal comparisons remain `0`.
  *
- * **Example** (Reversing Order)
+ * **Example** (Reversing an Order)
  *
  * ```ts
  * import { Order } from "effect"
@@ -215,7 +215,7 @@ export function flip(O) {
  * returned; otherwise, the second order is applied. The result is the first
  * non-zero comparison result, or `0` if both orders return `0`.
  *
- * **Example** (Combining Orders)
+ * **Example** (Combining two Orders)
  *
  * ```ts
  * import { Order } from "effect"
@@ -262,7 +262,7 @@ export const combine = /*#__PURE__*/dual(2, (self, that) => make((a1, a2) => {
  * Always returns `0` regardless of input values, making it useful as a neutral
  * element in order composition.
  *
- * **Example** (Always Equal Order)
+ * **Example** (Ordering with an always-equal Order)
  *
  * ```ts
  * import { Order } from "effect"
@@ -294,7 +294,7 @@ export function alwaysEqual() {
  * Applies orders in iteration order and short-circuits on the first non-zero
  * result. It returns `0` only if all orders return `0`.
  *
- * **Example** (Combining Multiple Orders)
+ * **Example** (Combining multiple Orders)
  *
  * ```ts
  * import { Order } from "effect"
@@ -379,7 +379,7 @@ export const mapInput = /*#__PURE__*/dual(2, (self, f) => make((b1, b2) => self(
  * Earlier dates are less than later dates. Invalid dates are compared through
  * their `getTime()` result.
  *
- * **Example** (Date Ordering)
+ * **Example** (Ordering Dates)
  *
  * ```ts
  * import { Order } from "effect"
@@ -410,7 +410,7 @@ export const Date = /*#__PURE__*/mapInput(Number, date => date.getTime());
  * the first non-zero comparison result. Tuples must have the same length as the
  * order collection, and the result is `0` only if all elements are equal.
  *
- * **Example** (Tuple Ordering)
+ * **Example** (Ordering tuples)
  *
  * ```ts
  * import { Order } from "effect"
@@ -470,7 +470,7 @@ export {
  * are less than longer arrays. The result is `0` only if arrays have the same
  * length and all elements are equal.
  *
- * **Example** (Array Element Ordering)
+ * **Example** (Ordering array elements)
  *
  * ```ts
  * import { Order } from "effect"
@@ -501,7 +501,7 @@ Array_ as Array };
  * stops at the first non-zero comparison result. Field order matters: earlier
  * fields take precedence. The result is `0` only if all fields are equal.
  *
- * **Example** (Struct Ordering)
+ * **Example** (Ordering structs)
  *
  * ```ts
  * import { Order } from "effect"
@@ -549,7 +549,7 @@ export function Struct(fields) {
  * Returns `true` if the order returns `-1`, meaning the first value is less
  * than the second. Equal or greater values return `false`.
  *
- * **Example** (Less Than)
+ * **Example** (Checking less-than comparisons)
  *
  * ```ts
  * import { Order } from "effect"
@@ -579,7 +579,7 @@ export const isLessThan = O => dual(2, (self, that) => O(self, that) === -1);
  * Returns `true` if the order returns `1`, meaning the first value is greater
  * than the second. Equal or lesser values return `false`.
  *
- * **Example** (Greater Than)
+ * **Example** (Checking greater-than comparisons)
  *
  * ```ts
  * import { Order } from "effect"
@@ -609,7 +609,7 @@ export const isGreaterThan = O => dual(2, (self, that) => O(self, that) === 1);
  * Returns `true` if the order returns `-1` or `0`, and returns `false` only if
  * the order returns `1`.
  *
- * **Example** (Less Than Or Equal)
+ * **Example** (Checking less-than-or-equal comparisons)
  *
  * ```ts
  * import { Order } from "effect"
@@ -640,7 +640,7 @@ export const isLessThanOrEqualTo = O => dual(2, (self, that) => O(self, that) !=
  * Returns `true` if the order returns `1` or `0`, and returns `false` only if
  * the order returns `-1`.
  *
- * **Example** (Greater Than Or Equal)
+ * **Example** (Checking greater-than-or-equal comparisons)
  *
  * ```ts
  * import { Order } from "effect"
@@ -671,7 +671,7 @@ export const isGreaterThanOrEqualTo = O => dual(2, (self, that) => O(self, that)
  * Returns the value that compares as less than or equal to the other value. If
  * values are equal, the first argument is returned.
  *
- * **Example** (Minimum Value)
+ * **Example** (Selecting the minimum value)
  *
  * ```ts
  * import { Order } from "effect"
@@ -702,7 +702,7 @@ export const min = O => dual(2, (self, that) => self === that || O(self, that) <
  * Returns the value that compares as greater than or equal to the other value.
  * If values are equal, the first argument is returned.
  *
- * **Example** (Maximum Value)
+ * **Example** (Selecting the maximum value)
  *
  * ```ts
  * import { Order } from "effect"
@@ -735,7 +735,7 @@ export const max = O => dual(2, (self, that) => self === that || O(self, that) >
  * maximum. The minimum must be less than or equal to the maximum according to
  * the order.
  *
- * **Example** (Clamping Values)
+ * **Example** (Clamping values)
  *
  * ```ts
  * import { Order } from "effect"
@@ -769,7 +769,7 @@ export const clamp = O => dual(2, (self, options) => min(O)(options.maximum, max
  * than or equal to maximum. Values outside the range return `false`. Both
  * bounds are inclusive.
  *
- * **Example** (Checking Range)
+ * **Example** (Checking ranges)
  *
  * ```ts
  * import { Order } from "effect"

package/dist/Pool.d.ts

@@ -218,7 +218,7 @@ export declare const make: <A, E, R>(options: {
  * from item creation, while `"usage"` measures from pool usage. The default is
  * `"usage"`.
  *
- * **Example** (Create a connection pool)
+ * **Example** (Creating a connection pool)
  *
  * ```ts
  * import { Duration, Effect, Pool } from "effect"

package/dist/Pool.js

@@ -86,7 +86,7 @@ export const make = options => makeWithStrategy({
  * from item creation, while `"usage"` measures from pool usage. The default is
  * `"usage"`.
  *
- * **Example** (Create a connection pool)
+ * **Example** (Creating a connection pool)
  *
  * ```ts
  * import { Duration, Effect, Pool } from "effect"