effect 4.0.0-beta.67 → 4.0.0-beta.69

package/src/Chunk.ts

@@ -144,11 +144,10 @@ export interface NonEmptyChunk<out A> extends Chunk<A>, NonEmptyIterable<A> {}
  * **Example** (Applying the Chunk type lambda)
  *
  * ```ts
- * import type { ChunkTypeLambda } from "effect/Chunk"
- * import type { Kind } from "effect/HKT"
+ * import type { Chunk, HKT } from "effect"
  *
  * // Create a Chunk type using the type lambda
- * type NumberChunk = Kind<ChunkTypeLambda, never, never, never, number>
+ * type NumberChunk = HKT.Kind<Chunk.ChunkTypeLambda, never, never, never, number>
  * // Equivalent to: Chunk<number>
  * ```
  *
@@ -215,8 +214,7 @@ const emptyArray: ReadonlyArray<never> = []
  * **Example** (Comparing chunks for equivalence)
  *
  * ```ts
- * import { Chunk } from "effect"
- * import * as Equivalence from "effect/Equivalence"
+ * import { Chunk, Equivalence } from "effect"
  *
  * const chunk1 = Chunk.make(1, 2, 3)
  * const chunk2 = Chunk.make(1, 2, 3)
@@ -228,7 +226,7 @@ const emptyArray: ReadonlyArray<never> = []
  * ```
  *
  * @category equivalence
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const makeEquivalence = <A>(isEquivalent: Equivalence.Equivalence<A>): Equivalence.Equivalence<Chunk<A>> =>
   Equivalence.make((self, that) =>
@@ -504,7 +502,7 @@ const toArray_ = <A>(self: Chunk<A>): Array<A> => toReadonlyArray(self).slice()
  * console.log(Chunk.toArray(emptyChunk)) // []
  * ```
  *
- * @category conversions
+ * @category converting
  * @since 2.0.0
  */
 export const toArray: <S extends Chunk<any>>(
@@ -556,7 +554,7 @@ const toReadonlyArray_ = <A>(self: Chunk<A>): ReadonlyArray<A> => {
  * console.log(Chunk.toReadonlyArray(emptyChunk)) // []
  * ```
  *
- * @category conversions
+ * @category converting
  * @since 2.0.0
  */
 export const toReadonlyArray: <S extends Chunk<any>>(
@@ -693,7 +691,7 @@ export const get: {
  * ```
  *
  * @category unsafe
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const fromArrayUnsafe = <A>(self: ReadonlyArray<A>): Chunk<A> =>
   self.length === 0 ? empty() : self.length === 1 ? of(self[0]) : makeChunk({ _tag: "IArray", array: self })
@@ -704,8 +702,7 @@ export const fromArrayUnsafe = <A>(self: ReadonlyArray<A>): Chunk<A> =>
  * **Example** (Creating non-empty chunks without copying arrays)
  *
  * ```ts
- * import { Chunk } from "effect"
- * import * as Array from "effect/Array"
+ * import { Array, Chunk } from "effect"
  *
  * const nonEmptyArray = Array.make(1, 2, 3, 4, 5)
  * const chunk = Chunk.fromNonEmptyArrayUnsafe(nonEmptyArray)
@@ -716,7 +713,7 @@ export const fromArrayUnsafe = <A>(self: ReadonlyArray<A>): Chunk<A> =>
  * ```
  *
  * @category unsafe
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const fromNonEmptyArrayUnsafe = <A>(self: NonEmptyReadonlyArray<A>): NonEmptyChunk<A> =>
   fromArrayUnsafe(self) as any
@@ -739,7 +736,7 @@ export const fromNonEmptyArrayUnsafe = <A>(self: NonEmptyReadonlyArray<A>): NonE
  * ```
  *
  * @category unsafe
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const getUnsafe: {
   /**
@@ -760,7 +757,7 @@ export const getUnsafe: {
    * ```
    *
    * @category unsafe
-   * @since 2.0.0
+   * @since 4.0.0
    */
   (index: number): <A>(self: Chunk<A>) => A
   /**
@@ -781,7 +778,7 @@ export const getUnsafe: {
    * ```
    *
    * @category unsafe
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <A>(self: Chunk<A>, index: number): A
 } = dual(2, <A>(self: Chunk<A>, index: number): A => {
@@ -1530,8 +1527,7 @@ export const appendAll: {
  * **Example** (Filtering and mapping values)
  *
  * ```ts
- * import { Chunk } from "effect"
- * import * as Result from "effect/Result"
+ * import { Chunk, Result } from "effect"
  *
  * const chunk = Chunk.make("1", "2", "hello", "3", "world")
  * const numbers = Chunk.filterMap(chunk, (str) => {
@@ -1558,8 +1554,7 @@ export const filterMap: {
    * **Example** (Filtering and mapping values)
    *
    * ```ts
-   * import { Chunk } from "effect"
-   * import * as Result from "effect/Result"
+   * import { Chunk, Result } from "effect"
    *
    * const chunk = Chunk.make("1", "2", "hello", "3", "world")
    * const numbers = Chunk.filterMap(chunk, (str) => {
@@ -1586,8 +1581,7 @@ export const filterMap: {
    * **Example** (Filtering and mapping values)
    *
    * ```ts
-   * import { Chunk } from "effect"
-   * import * as Result from "effect/Result"
+   * import { Chunk, Result } from "effect"
    *
    * const chunk = Chunk.make("1", "2", "hello", "3", "world")
    * const numbers = Chunk.filterMap(chunk, (str) => {
@@ -1744,8 +1738,7 @@ export const filter: {
  * **Example** (Filtering and mapping while values match)
  *
  * ```ts
- * import { Chunk } from "effect"
- * import * as Result from "effect/Result"
+ * import { Chunk, Result } from "effect"
  *
  * const chunk = Chunk.make("1", "2", "hello", "3", "4")
  * const result = Chunk.filterMapWhile(chunk, (s) => {
@@ -1773,8 +1766,7 @@ export const filterMapWhile: {
    * **Example** (Filtering and mapping while values match)
    *
    * ```ts
-   * import { Chunk } from "effect"
-   * import * as Result from "effect/Result"
+   * import { Chunk, Result } from "effect"
    *
    * const chunk = Chunk.make("1", "2", "hello", "3", "4")
    * const result = Chunk.filterMapWhile(chunk, (s) => {
@@ -1802,8 +1794,7 @@ export const filterMapWhile: {
    * **Example** (Filtering and mapping while values match)
    *
    * ```ts
-   * import { Chunk } from "effect"
-   * import * as Result from "effect/Result"
+   * import { Chunk, Result } from "effect"
    *
    * const chunk = Chunk.make("1", "2", "hello", "3", "4")
    * const result = Chunk.filterMapWhile(chunk, (s) => {
@@ -1844,8 +1835,7 @@ export const filterMapWhile: {
  * **Example** (Compacting optional values)
  *
  * ```ts
- * import { Chunk } from "effect"
- * import * as Option from "effect/Option"
+ * import { Chunk, Option } from "effect"
  *
  * const chunk = Chunk.make(Option.some(1), Option.none(), Option.some(3))
  * const result = Chunk.compact(chunk)
@@ -2398,7 +2388,7 @@ export const head: <A>(self: Chunk<A>) => Option<A> = get(0)
  * ```
  *
  * @category unsafe
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const headUnsafe = <A>(self: Chunk<A>): A => getUnsafe(self, 0)
 
@@ -2463,7 +2453,7 @@ export const last = <A>(self: Chunk<A>): Option<A> => get(self, self.length - 1)
  * ```
  *
  * @category unsafe
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const lastUnsafe = <A>(self: Chunk<A>): A => getUnsafe(self, self.length - 1)
 
@@ -2507,7 +2497,6 @@ export const lastNonEmpty: <A>(self: NonEmptyChunk<A>) => A = lastUnsafe
  * type WithString = Chunk.Chunk.With<typeof nonEmptyChunk, string> // Chunk.NonEmptyChunk<string>
  * ```
  *
- * @category types
  * @since 2.0.0
  */
 export declare namespace Chunk {
@@ -2911,8 +2900,7 @@ export const partition: {
  * **Example** (Separating failures and successes)
  *
  * ```ts
- * import { Chunk } from "effect"
- * import * as Result from "effect/Result"
+ * import { Chunk, Result } from "effect"
  *
  * const chunk = Chunk.make(
  *   Result.succeed(1),
@@ -2965,8 +2953,7 @@ export const size = <A>(self: Chunk<A>): number => self.length
  * **Example** (Sorting chunks)
  *
  * ```ts
- * import { Chunk } from "effect"
- * import * as Order from "effect/Order"
+ * import { Chunk, Order } from "effect"
  *
  * const numbers = Chunk.make(3, 1, 4, 1, 5, 9, 2, 6)
  * const sorted = Chunk.sort(numbers, Order.Number)
@@ -2992,8 +2979,7 @@ export const sort: {
    * **Example** (Sorting chunks)
    *
    * ```ts
-   * import { Chunk } from "effect"
-   * import * as Order from "effect/Order"
+   * import { Chunk, Order } from "effect"
    *
    * const numbers = Chunk.make(3, 1, 4, 1, 5, 9, 2, 6)
    * const sorted = Chunk.sort(numbers, Order.Number)
@@ -3019,8 +3005,7 @@ export const sort: {
    * **Example** (Sorting chunks)
    *
    * ```ts
-   * import { Chunk } from "effect"
-   * import * as Order from "effect/Order"
+   * import { Chunk, Order } from "effect"
    *
    * const numbers = Chunk.make(3, 1, 4, 1, 5, 9, 2, 6)
    * const sorted = Chunk.sort(numbers, Order.Number)
@@ -3051,8 +3036,7 @@ export const sort: {
  * **Example** (Sorting chunks by a derived value)
  *
  * ```ts
- * import { Chunk } from "effect"
- * import * as Order from "effect/Order"
+ * import { Chunk, Order } from "effect"
  *
  * const people = Chunk.make(
  *   { name: "Alice", age: 30 },
@@ -3086,8 +3070,7 @@ export const sortWith: {
    * **Example** (Sorting chunks by a derived value)
    *
    * ```ts
-   * import { Chunk } from "effect"
-   * import * as Order from "effect/Order"
+   * import { Chunk, Order } from "effect"
    *
    * const people = Chunk.make(
    *   { name: "Alice", age: 30 },
@@ -3121,8 +3104,7 @@ export const sortWith: {
    * **Example** (Sorting chunks by a derived value)
    *
    * ```ts
-   * import { Chunk } from "effect"
-   * import * as Order from "effect/Order"
+   * import { Chunk, Order } from "effect"
    *
    * const people = Chunk.make(
    *   { name: "Alice", age: 30 },
@@ -4816,8 +4798,7 @@ export const findFirstIndex: {
  * **Example** (Finding the last matching element)
  *
  * ```ts
- * import { Chunk } from "effect"
- * import * as Option from "effect/Option"
+ * import { Chunk, Option } from "effect"
  *
  * const chunk = Chunk.make(1, 2, 3, 4, 5)
  * const result = Chunk.findLast(chunk, (n) => n < 4)
@@ -4843,8 +4824,7 @@ export const findLast: {
    * **Example** (Finding the last matching element)
    *
    * ```ts
-   * import { Chunk } from "effect"
-   * import * as Option from "effect/Option"
+   * import { Chunk, Option } from "effect"
    *
    * const chunk = Chunk.make(1, 2, 3, 4, 5)
    * const result = Chunk.findLast(chunk, (n) => n < 4)
@@ -4870,8 +4850,7 @@ export const findLast: {
    * **Example** (Finding the last matching element)
    *
    * ```ts
-   * import { Chunk } from "effect"
-   * import * as Option from "effect/Option"
+   * import { Chunk, Option } from "effect"
    *
    * const chunk = Chunk.make(1, 2, 3, 4, 5)
    * const result = Chunk.findLast(chunk, (n) => n < 4)
@@ -4897,8 +4876,7 @@ export const findLast: {
    * **Example** (Finding the last matching element)
    *
    * ```ts
-   * import { Chunk } from "effect"
-   * import * as Option from "effect/Option"
+   * import { Chunk, Option } from "effect"
    *
    * const chunk = Chunk.make(1, 2, 3, 4, 5)
    * const result = Chunk.findLast(chunk, (n) => n < 4)
@@ -4924,8 +4902,7 @@ export const findLast: {
    * **Example** (Finding the last matching element)
    *
    * ```ts
-   * import { Chunk } from "effect"
-   * import * as Option from "effect/Option"
+   * import { Chunk, Option } from "effect"
    *
    * const chunk = Chunk.make(1, 2, 3, 4, 5)
    * const result = Chunk.findLast(chunk, (n) => n < 4)

package/src/Clock.ts

@@ -122,7 +122,7 @@ export interface Clock {
  * ```
  *
  * @category references
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const Clock: Context.Reference<Clock> = effect.ClockRef
 

package/src/Combiner.ts

@@ -88,7 +88,7 @@ import type * as Order from "./Order.ts"
  *
  * @see {@link make} – create a `Combiner` from a function
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export interface Combiner<A> {
@@ -121,6 +121,7 @@ export interface Combiner<A> {
  *
  * @see {@link Combiner} – the interface this creates
  *
+ * @category constructors
  * @since 4.0.0
  */
 export function make<A>(combine: (self: A, that: A) => A): Combiner<A> {
@@ -153,6 +154,7 @@ export function make<A>(combine: (self: A, that: A) => A): Combiner<A> {
  *
  * @see {@link make}
  *
+ * @category combinators
  * @since 4.0.0
  */
 export function flip<A>(combiner: Combiner<A>): Combiner<A> {
@@ -188,6 +190,7 @@ export function flip<A>(combiner: Combiner<A>): Combiner<A> {
  *
  * @see {@link max}
  *
+ * @category constructors
  * @since 4.0.0
  */
 export function min<A>(order: Order.Order<A>): Combiner<A> {
@@ -223,6 +226,7 @@ export function min<A>(order: Order.Order<A>): Combiner<A> {
  *
  * @see {@link min}
  *
+ * @category constructors
  * @since 4.0.0
  */
 export function max<A>(order: Order.Order<A>): Combiner<A> {
@@ -254,6 +258,7 @@ export function max<A>(order: Order.Order<A>): Combiner<A> {
  *
  * @see {@link last}
  *
+ * @category constructors
  * @since 4.0.0
  */
 export function first<A>(): Combiner<A> {
@@ -284,6 +289,7 @@ export function first<A>(): Combiner<A> {
  *
  * @see {@link first}
  *
+ * @category constructors
  * @since 4.0.0
  */
 export function last<A>(): Combiner<A> {
@@ -317,6 +323,7 @@ export function last<A>(): Combiner<A> {
  * @see {@link first}
  * @see {@link last}
  *
+ * @category constructors
  * @since 4.0.0
  */
 export function constant<A>(a: A): Combiner<A> {
@@ -351,6 +358,7 @@ export function constant<A>(a: A): Combiner<A> {
  *
  * @see {@link make}
  *
+ * @category combinators
  * @since 4.0.0
  */
 export function intercalate<A>(middle: A) {