effect 4.0.0-beta.67 → 4.0.0-beta.68

package/src/Array.ts

@@ -462,7 +462,7 @@ export const ensure = <A>(self: ReadonlyArray<A> | A): Array<A> => Array.isArray
  * console.log(result) // [["a", 1], ["b", 2], ["c", 3]]
  * ```
  *
- * @category conversions
+ * @category converting
  * @since 2.0.0
  */
 export const fromRecord: <K extends string, A>(self: Readonly<Record<K, A>>) => Array<[K, A]> = Record.toEntries
@@ -481,7 +481,7 @@ export const fromRecord: <K extends string, A>(self: Readonly<Record<K, A>>) =>
  *
  * @see {@link getSomes} — extract `Some` values from an array of Options
  *
- * @category conversions
+ * @category converting
  * @since 2.0.0
  */
 export const fromOption: <A>(self: Option.Option<A>) => Array<A> = Option.toArray
@@ -1394,7 +1394,7 @@ export const isArray: {
  * @see {@link isArrayNonEmpty} — opposite check
  *
  * @category guards
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const isArrayEmpty = <A>(self: Array<A>): self is [] => self.length === 0
 
@@ -1414,7 +1414,7 @@ export const isArrayEmpty = <A>(self: Array<A>): self is [] => self.length === 0
  * @see {@link isReadonlyArrayNonEmpty} — opposite check
  *
  * @category guards
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const isReadonlyArrayEmpty: <A>(self: ReadonlyArray<A>) => self is readonly [] = isArrayEmpty as any
 
@@ -1435,7 +1435,7 @@ export const isReadonlyArrayEmpty: <A>(self: ReadonlyArray<A>) => self is readon
  * @see {@link isArrayEmpty} — opposite check
  *
  * @category guards
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const isArrayNonEmpty: <A>(self: Array<A>) => self is NonEmptyArray<A> = internalArray.isArrayNonEmpty
 
@@ -1456,7 +1456,7 @@ export const isArrayNonEmpty: <A>(self: Array<A>) => self is NonEmptyArray<A> =
  * @see {@link isReadonlyArrayEmpty} — opposite check
  *
  * @category guards
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const isReadonlyArrayNonEmpty: <A>(self: ReadonlyArray<A>) => self is NonEmptyReadonlyArray<A> =
   internalArray.isArrayNonEmpty
@@ -1579,7 +1579,7 @@ export const get: {
  * @see {@link get} — safe version returning `Option`
  *
  * @category unsafe
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const getUnsafe: {
   /**
@@ -1600,7 +1600,7 @@ export const getUnsafe: {
    * @see {@link get} — safe version returning `Option`
    *
    * @category unsafe
-   * @since 2.0.0
+   * @since 4.0.0
    */
   (index: number): <A>(self: ReadonlyArray<A>) => A
   /**
@@ -1621,7 +1621,7 @@ export const getUnsafe: {
    * @see {@link get} — safe version returning `Option`
    *
    * @category unsafe
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <A>(self: ReadonlyArray<A>, index: number): A
 } = dual(2, <A>(self: ReadonlyArray<A>, index: number): A => {
@@ -4169,7 +4169,7 @@ export const intersperse: {
  * @see {@link modifyLastNonEmpty} — modify the last element
  *
  * @category elements
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const modifyHeadNonEmpty: {
   /**
@@ -4188,7 +4188,7 @@ export const modifyHeadNonEmpty: {
    * @see {@link modifyLastNonEmpty} — modify the last element
    *
    * @category elements
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <A, B>(f: (a: A) => B): (self: NonEmptyReadonlyArray<A>) => NonEmptyArray<A | B>
   /**
@@ -4207,7 +4207,7 @@ export const modifyHeadNonEmpty: {
    * @see {@link modifyLastNonEmpty} — modify the last element
    *
    * @category elements
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <A, B>(self: NonEmptyReadonlyArray<A>, f: (a: A) => B): NonEmptyArray<A | B>
 } = dual(
@@ -4233,7 +4233,7 @@ export const modifyHeadNonEmpty: {
  * @see {@link setLastNonEmpty} — replace the last element
  *
  * @category elements
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const setHeadNonEmpty: {
   /**
@@ -4251,7 +4251,7 @@ export const setHeadNonEmpty: {
    * @see {@link setLastNonEmpty} — replace the last element
    *
    * @category elements
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <B>(b: B): <A>(self: NonEmptyReadonlyArray<A>) => NonEmptyArray<A | B>
   /**
@@ -4269,7 +4269,7 @@ export const setHeadNonEmpty: {
    * @see {@link setLastNonEmpty} — replace the last element
    *
    * @category elements
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <A, B>(self: NonEmptyReadonlyArray<A>, b: B): NonEmptyArray<A | B>
 } = dual(
@@ -4293,7 +4293,7 @@ export const setHeadNonEmpty: {
  * @see {@link modifyHeadNonEmpty} — modify the first element
  *
  * @category elements
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const modifyLastNonEmpty: {
   /**
@@ -4312,7 +4312,7 @@ export const modifyLastNonEmpty: {
    * @see {@link modifyHeadNonEmpty} — modify the first element
    *
    * @category elements
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <A, B>(f: (a: A) => B): (self: NonEmptyReadonlyArray<A>) => NonEmptyArray<A | B>
   /**
@@ -4331,7 +4331,7 @@ export const modifyLastNonEmpty: {
    * @see {@link modifyHeadNonEmpty} — modify the first element
    *
    * @category elements
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <A, B>(self: NonEmptyReadonlyArray<A>, f: (a: A) => B): NonEmptyArray<A | B>
 } = dual(
@@ -4355,7 +4355,7 @@ export const modifyLastNonEmpty: {
  * @see {@link setHeadNonEmpty} — replace the first element
  *
  * @category elements
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const setLastNonEmpty: {
   /**
@@ -4373,7 +4373,7 @@ export const setLastNonEmpty: {
    * @see {@link setHeadNonEmpty} — replace the first element
    *
    * @category elements
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <B>(b: B): <A>(self: NonEmptyReadonlyArray<A>) => NonEmptyArray<A | B>
   /**
@@ -4391,7 +4391,7 @@ export const setLastNonEmpty: {
    * @see {@link setHeadNonEmpty} — replace the first element
    *
    * @category elements
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <A, B>(self: NonEmptyReadonlyArray<A>, b: B): NonEmptyArray<A | B>
 } = dual(
@@ -4813,7 +4813,7 @@ export const splitAt: {
  * @see {@link splitAt} — for possibly-empty arrays
  *
  * @category splitting
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const splitAtNonEmpty: {
   /**
@@ -4832,7 +4832,7 @@ export const splitAtNonEmpty: {
    * @see {@link splitAt} — for possibly-empty arrays
    *
    * @category splitting
-   * @since 2.0.0
+   * @since 4.0.0
    */
   (n: number): <A>(self: NonEmptyReadonlyArray<A>) => [beforeIndex: NonEmptyArray<A>, fromIndex: Array<A>]
   /**
@@ -4851,7 +4851,7 @@ export const splitAtNonEmpty: {
    * @see {@link splitAt} — for possibly-empty arrays
    *
    * @category splitting
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <A>(self: NonEmptyReadonlyArray<A>, n: number): [beforeIndex: NonEmptyArray<A>, fromIndex: Array<A>]
 } = dual(2, <A>(self: NonEmptyReadonlyArray<A>, n: number): [NonEmptyArray<A>, Array<A>] => {
@@ -6022,7 +6022,6 @@ export const of = <A>(a: A): NonEmptyArray<A> => [a]
  * Utility types for working with `ReadonlyArray` at the type level. Use these
  * to infer element types, preserve non-emptiness, and flatten nested arrays.
  *
- * @category types
  * @since 2.0.0
  */
 export declare namespace ReadonlyArray {
@@ -6370,7 +6369,7 @@ export const getSomes: <T extends Iterable<Option.Option<X>>, X = any>(
  * @see {@link separate} — split into failures and successes
  *
  * @category filtering
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const getFailures = <T extends Iterable<Result.Result<any, any>>>(
   self: T
@@ -6402,7 +6401,7 @@ export const getFailures = <T extends Iterable<Result.Result<any, any>>>(
  * @see {@link separate} — split into failures and successes
  *
  * @category filtering
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const getSuccesses = <T extends Iterable<Result.Result<any, any>>>(
   self: T
@@ -6435,7 +6434,7 @@ export const getSuccesses = <T extends Iterable<Result.Result<any, any>>>(
  * @see {@link filter} — keep original elements matching a predicate
  *
  * @category filtering
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const filterMap: {
   /**
@@ -6456,7 +6455,7 @@ export const filterMap: {
    * @see {@link filter} — keep original elements matching a predicate
    *
    * @category filtering
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <A, B, X>(f: (input: NoInfer<A>, i: number) => Result.Result<B, X>): (self: Iterable<A>) => Array<B>
   /**
@@ -6477,7 +6476,7 @@ export const filterMap: {
    * @see {@link filter} — keep original elements matching a predicate
    *
    * @category filtering
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <A, B, X>(self: Iterable<A>, f: (input: A, i: number) => Result.Result<B, X>): Array<B>
 } = dual(2, <A, B, X>(self: Iterable<A>, f: (input: A, i: number) => Result.Result<B, X>): Array<B> => {
@@ -6624,7 +6623,7 @@ export const filter: {
  * ```
  *
  * @see {@link filter} — keep only matching elements
- * @see {@link partitionMap} — partition using a Result-returning function
+ * @see {@link separate} — split an iterable of `Result` values
  *
  * @category filtering
  * @since 2.0.0
@@ -6648,7 +6647,7 @@ export const partition: {
    * ```
    *
    * @see {@link filter} — keep only matching elements
-   * @see {@link partitionMap} — partition using a Result-returning function
+   * @see {@link separate} — split an iterable of `Result` values
    *
    * @category filtering
    * @since 2.0.0
@@ -6672,7 +6671,7 @@ export const partition: {
    * ```
    *
    * @see {@link filter} — keep only matching elements
-   * @see {@link partitionMap} — partition using a Result-returning function
+   * @see {@link separate} — split an iterable of `Result` values
    *
    * @category filtering
    * @since 2.0.0
@@ -6952,8 +6951,8 @@ export const liftOption = <A extends Array<unknown>, B>(
  * @see {@link liftNullishOr} — lift a nullable-returning function
  * @see {@link fromOption} — convert from Option
  *
- * @category conversions
- * @since 2.0.0
+ * @category converting
+ * @since 4.0.0
  */
 export const fromNullishOr = <A>(a: A): Array<NonNullable<A>> => a == null ? empty() : [a as NonNullable<A>]
 
@@ -6978,7 +6977,7 @@ export const fromNullishOr = <A>(a: A): Array<NonNullable<A>> => a == null ? emp
  * @see {@link liftOption} — lift an Option-returning function
  *
  * @category lifting
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const liftNullishOr = <A extends Array<unknown>, B>(
   f: (...a: A) => B
@@ -6999,7 +6998,7 @@ export const liftNullishOr = <A extends Array<unknown>, B>(
  * ```
  *
  * @category sequencing
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const flatMapNullishOr: {
   /**
@@ -7016,7 +7015,7 @@ export const flatMapNullishOr: {
    * ```
    *
    * @category sequencing
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <A, B>(f: (a: A) => B): (self: ReadonlyArray<A>) => Array<NonNullable<B>>
   /**
@@ -7033,7 +7032,7 @@ export const flatMapNullishOr: {
    * ```
    *
    * @category sequencing
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <A, B>(self: ReadonlyArray<A>, f: (a: A) => B): Array<NonNullable<B>>
 } = dual(
@@ -7064,7 +7063,7 @@ export const flatMapNullishOr: {
  * @see {@link liftPredicate} — lift a boolean predicate
  *
  * @category lifting
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const liftResult = <A extends Array<unknown>, E, B>(
   f: (...a: A) => Result.Result<B, E>
@@ -7470,7 +7469,7 @@ export const unfold = <B, A>(b: B, f: (b: B) => Option.Option<readonly [A, B]>):
  * @see {@link makeEquivalence} — create an equivalence for arrays
  *
  * @category instances
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const makeOrder: <A>(O: Order.Order<A>) => Order.Order<ReadonlyArray<A>> = Order.Array
 
@@ -7491,7 +7490,7 @@ export const makeOrder: <A>(O: Order.Order<A>) => Order.Order<ReadonlyArray<A>>
  * @see {@link makeOrder} — create an ordering for arrays
  *
  * @category instances
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const makeEquivalence: <A>(
   isEquivalent: Equivalence.Equivalence<A>