effect 3.13.7 → 3.13.9

package/src/Boolean.ts

@@ -14,10 +14,9 @@ import * as predicate from "./Predicate.js"
 /**
  * Tests if a value is a `boolean`.
  *
- * @param input - The value to test.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { isBoolean } from "effect/Boolean"
  *
  * assert.deepStrictEqual(isBoolean(true), true)
@@ -33,12 +32,9 @@ export const isBoolean: (input: unknown) => input is boolean = predicate.isBoole
  * This function returns the result of either of the given functions depending on the value of the boolean parameter.
  * It is useful when you have to run one of two functions depending on the boolean value.
  *
- * @param value - the boolean value that decides which function will be executed.
- * @param onFalse - a lazy evaluation function that will be executed when the `value` is `false`.
- * @param onTrue - a lazy evaluation function that will be executed when the `value` is `true`.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Boolean } from "effect"
  *
  * assert.deepStrictEqual(Boolean.match(true, { onFalse: () => "It's false!", onTrue: () => "It's true!" }), "It's true!")
@@ -52,12 +48,9 @@ export const match: {
    * This function returns the result of either of the given functions depending on the value of the boolean parameter.
    * It is useful when you have to run one of two functions depending on the boolean value.
    *
-   * @param value - the boolean value that decides which function will be executed.
-   * @param onFalse - a lazy evaluation function that will be executed when the `value` is `false`.
-   * @param onTrue - a lazy evaluation function that will be executed when the `value` is `true`.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Boolean } from "effect"
    *
    * assert.deepStrictEqual(Boolean.match(true, { onFalse: () => "It's false!", onTrue: () => "It's true!" }), "It's true!")
@@ -76,12 +69,9 @@ export const match: {
    * This function returns the result of either of the given functions depending on the value of the boolean parameter.
    * It is useful when you have to run one of two functions depending on the boolean value.
    *
-   * @param value - the boolean value that decides which function will be executed.
-   * @param onFalse - a lazy evaluation function that will be executed when the `value` is `false`.
-   * @param onTrue - a lazy evaluation function that will be executed when the `value` is `true`.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Boolean } from "effect"
    *
    * assert.deepStrictEqual(Boolean.match(true, { onFalse: () => "It's false!", onTrue: () => "It's true!" }), "It's true!")
@@ -119,6 +109,7 @@ export const Order: order.Order<boolean> = order.boolean
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { not } from "effect/Boolean"
  *
  * assert.deepStrictEqual(not(true), false)
@@ -135,6 +126,7 @@ export const not = (self: boolean): boolean => !self
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { and } from "effect/Boolean"
  *
  * assert.deepStrictEqual(and(true, true), true)
@@ -152,6 +144,7 @@ export const and: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { and } from "effect/Boolean"
    *
    * assert.deepStrictEqual(and(true, true), true)
@@ -169,6 +162,7 @@ export const and: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { and } from "effect/Boolean"
    *
    * assert.deepStrictEqual(and(true, true), true)
@@ -188,6 +182,7 @@ export const and: {
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { nand } from "effect/Boolean"
  *
  * assert.deepStrictEqual(nand(true, true), false)
@@ -205,6 +200,7 @@ export const nand: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { nand } from "effect/Boolean"
    *
    * assert.deepStrictEqual(nand(true, true), false)
@@ -222,6 +218,7 @@ export const nand: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { nand } from "effect/Boolean"
    *
    * assert.deepStrictEqual(nand(true, true), false)
@@ -241,6 +238,7 @@ export const nand: {
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { or } from "effect/Boolean"
  *
  * assert.deepStrictEqual(or(true, true), true)
@@ -258,6 +256,7 @@ export const or: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { or } from "effect/Boolean"
    *
    * assert.deepStrictEqual(or(true, true), true)
@@ -275,6 +274,7 @@ export const or: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { or } from "effect/Boolean"
    *
    * assert.deepStrictEqual(or(true, true), true)
@@ -294,6 +294,7 @@ export const or: {
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { nor } from "effect/Boolean"
  *
  * assert.deepStrictEqual(nor(true, true), false)
@@ -311,6 +312,7 @@ export const nor: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { nor } from "effect/Boolean"
    *
    * assert.deepStrictEqual(nor(true, true), false)
@@ -328,6 +330,7 @@ export const nor: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { nor } from "effect/Boolean"
    *
    * assert.deepStrictEqual(nor(true, true), false)
@@ -347,6 +350,7 @@ export const nor: {
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { xor } from "effect/Boolean"
  *
  * assert.deepStrictEqual(xor(true, true), false)
@@ -364,6 +368,7 @@ export const xor: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { xor } from "effect/Boolean"
    *
    * assert.deepStrictEqual(xor(true, true), false)
@@ -381,6 +386,7 @@ export const xor: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { xor } from "effect/Boolean"
    *
    * assert.deepStrictEqual(xor(true, true), false)
@@ -400,6 +406,7 @@ export const xor: {
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { eqv } from "effect/Boolean"
  *
  * assert.deepStrictEqual(eqv(true, true), true)
@@ -417,6 +424,7 @@ export const eqv: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { eqv } from "effect/Boolean"
    *
    * assert.deepStrictEqual(eqv(true, true), true)
@@ -434,6 +442,7 @@ export const eqv: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { eqv } from "effect/Boolean"
    *
    * assert.deepStrictEqual(eqv(true, true), true)
@@ -453,6 +462,7 @@ export const eqv: {
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { implies } from "effect/Boolean"
  *
  * assert.deepStrictEqual(implies(true, true), true)
@@ -470,6 +480,7 @@ export const implies: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { implies } from "effect/Boolean"
    *
    * assert.deepStrictEqual(implies(true, true), true)
@@ -487,6 +498,7 @@ export const implies: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { implies } from "effect/Boolean"
    *
    * assert.deepStrictEqual(implies(true, true), true)
@@ -504,10 +516,9 @@ export const implies: {
 /**
  * This utility function is used to check if all the elements in a collection of boolean values are `true`.
  *
- * @param collection - An iterable collection of booleans.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { every } from "effect/Boolean"
  *
  * assert.deepStrictEqual(every([true, true, true]), true)
@@ -528,10 +539,9 @@ export const every = (collection: Iterable<boolean>): boolean => {
 /**
  * This utility function is used to check if at least one of the elements in a collection of boolean values is `true`.
  *
- * @param collection - An iterable collection of booleans.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { some } from "effect/Boolean"
  *
  * assert.deepStrictEqual(some([true, false, true]), true)

package/src/Brand.ts

@@ -192,11 +192,9 @@ export const errors: (...errors: Array<Brand.BrandErrors>) => Brand.BrandErrors
  * If you don't want to perform any validation but only distinguish between two values of the same type but with different meanings,
  * see {@link nominal}.
  *
- * @param refinement - The refinement predicate to apply to the unbranded value.
- * @param onFailure - Takes the unbranded value that did not pass the `refinement` predicate and returns a `BrandErrors`.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Brand } from "effect"
  *
  * type Int = number & Brand.Brand<"Int">
@@ -250,6 +248,7 @@ export function refined<A extends Brand<any>>(
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Brand } from "effect"
  *
  * type UserId = number & Brand.Brand<"UserId">
@@ -280,6 +279,7 @@ export const nominal = <A extends Brand<any>>(): Brand.Constructor<
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Brand } from "effect"
  *
  * type Int = number & Brand.Brand<"Int">

package/src/Channel.ts

@@ -1857,8 +1857,6 @@ export const mergeAllWith: (
  * happens if there are more than the given maximum number of channels gets
  * created. See `Channel.mergeAll`.
  *
- * @param n The maximum number of channels to merge.
- * @param f The function that creates a new channel from each emitted element.
  * @since 2.0.0
  * @category mapping
  */
@@ -1869,8 +1867,6 @@ export const mergeMap: {
    * happens if there are more than the given maximum number of channels gets
    * created. See `Channel.mergeAll`.
    *
-   * @param n The maximum number of channels to merge.
-   * @param f The function that creates a new channel from each emitted element.
    * @since 2.0.0
    * @category mapping
    */
@@ -1890,8 +1886,6 @@ export const mergeMap: {
    * happens if there are more than the given maximum number of channels gets
    * created. See `Channel.mergeAll`.
    *
-   * @param n The maximum number of channels to merge.
-   * @param f The function that creates a new channel from each emitted element.
    * @since 2.0.0
    * @category mapping
    */

package/src/Chunk.ts

@@ -362,6 +362,7 @@ const reverseChunk = <A>(self: Chunk<A>): Chunk<A> => {
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Chunk } from "effect"
  *
  * const numbers = Chunk.make(1, 2, 3)
@@ -679,6 +680,7 @@ export const dropWhile: {
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Chunk } from "effect"
  *
  * assert.deepStrictEqual(
@@ -697,6 +699,7 @@ export const prependAll: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Chunk } from "effect"
    *
    * assert.deepStrictEqual(
@@ -715,6 +718,7 @@ export const prependAll: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Chunk } from "effect"
    *
    * assert.deepStrictEqual(
@@ -733,6 +737,7 @@ export const prependAll: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Chunk } from "effect"
    *
    * assert.deepStrictEqual(
@@ -751,6 +756,7 @@ export const prependAll: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Chunk } from "effect"
    *
    * assert.deepStrictEqual(
@@ -771,6 +777,7 @@ export const prependAll: {
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Chunk } from "effect"
  *
  * assert.deepStrictEqual(
@@ -789,6 +796,7 @@ export const appendAll: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Chunk } from "effect"
    *
    * assert.deepStrictEqual(
@@ -807,6 +815,7 @@ export const appendAll: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Chunk } from "effect"
    *
    * assert.deepStrictEqual(
@@ -825,6 +834,7 @@ export const appendAll: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Chunk } from "effect"
    *
    * assert.deepStrictEqual(
@@ -843,6 +853,7 @@ export const appendAll: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Chunk } from "effect"
    *
    * assert.deepStrictEqual(
@@ -870,6 +881,7 @@ export const appendAll: {
      *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { Chunk } from "effect"
      *
      * assert.deepStrictEqual(
@@ -1284,6 +1296,7 @@ export declare namespace Chunk {
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Chunk } from "effect"
  *
  * assert.deepStrictEqual(
@@ -1302,6 +1315,7 @@ export const map: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Chunk } from "effect"
    *
    * assert.deepStrictEqual(
@@ -1320,6 +1334,7 @@ export const map: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Chunk } from "effect"
    *
    * assert.deepStrictEqual(
@@ -1338,6 +1353,7 @@ export const map: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Chunk } from "effect"
    *
    * assert.deepStrictEqual(

package/src/Config.ts

@@ -218,11 +218,6 @@ export const duration: (name?: string) => Config<Duration.Duration> = internal.d
  * use `isConfig` to check the type of a value before using it as an
  * argument to a function that expects an `Config` value.
  *
- * @param u - The value to check for being a `Config` value.
- *
- * @returns `true` if the specified value is a `Config` value, `false`
- * otherwise.
- *
  * @since 2.0.0
  * @category refinements
  */