effect 3.8.4 → 3.9.0

package/dist/dts/TArray.d.ts

@@ -41,7 +41,21 @@ export declare namespace TArray {
  * @category elements
  */
 export declare const collectFirst: {
+    /**
+     * Finds the result of applying a partial function to the first value in its
+     * domain.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A, B>(pf: (a: A) => Option.Option<B>): (self: TArray<A>) => STM.STM<Option.Option<B>>;
+    /**
+     * Finds the result of applying a partial function to the first value in its
+     * domain.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A, B>(self: TArray<A>, pf: (a: A) => Option.Option<B>): STM.STM<Option.Option<B>>;
 };
 /**
@@ -52,7 +66,21 @@ export declare const collectFirst: {
  * @category elements
  */
 export declare const collectFirstSTM: {
+    /**
+     * Finds the result of applying an transactional partial function to the first
+     * value in its domain.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A, B, E, R>(pf: (a: A) => Option.Option<STM.STM<B, E, R>>): (self: TArray<A>) => STM.STM<Option.Option<B>, E, R>;
+    /**
+     * Finds the result of applying an transactional partial function to the first
+     * value in its domain.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A, B, E, R>(self: TArray<A>, pf: (a: A) => Option.Option<STM.STM<B, E, R>>): STM.STM<Option.Option<B>, E, R>;
 };
 /**
@@ -63,7 +91,21 @@ export declare const collectFirstSTM: {
  * @category elements
  */
 export declare const contains: {
+    /**
+     * Determine if the array contains a specified value.
+     *
+     * @macro trace
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(value: A): (self: TArray<A>) => STM.STM<boolean>;
+    /**
+     * Determine if the array contains a specified value.
+     *
+     * @macro trace
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(self: TArray<A>, value: A): STM.STM<boolean>;
 };
 /**
@@ -74,7 +116,21 @@ export declare const contains: {
  * @category folding
  */
 export declare const count: {
+    /**
+     * Count the values in the array matching a predicate.
+     *
+     * @macro trace
+     * @since 2.0.0
+     * @category folding
+     */
     <A>(predicate: Predicate<A>): (self: TArray<A>) => STM.STM<number>;
+    /**
+     * Count the values in the array matching a predicate.
+     *
+     * @macro trace
+     * @since 2.0.0
+     * @category folding
+     */
     <A>(self: TArray<A>, predicate: Predicate<A>): STM.STM<number>;
 };
 /**
@@ -85,7 +141,21 @@ export declare const count: {
  * @category folding
  */
 export declare const countSTM: {
+    /**
+     * Count the values in the array matching a transactional predicate.
+     *
+     * @macro trace
+     * @since 2.0.0
+     * @category folding
+     */
     <A, R, E>(predicate: (value: A) => STM.STM<boolean, E, R>): (self: TArray<A>) => STM.STM<number, E, R>;
+    /**
+     * Count the values in the array matching a transactional predicate.
+     *
+     * @macro trace
+     * @since 2.0.0
+     * @category folding
+     */
     <A, R, E>(self: TArray<A>, predicate: (value: A) => STM.STM<boolean, E, R>): STM.STM<number, E, R>;
 };
 /**
@@ -103,7 +173,21 @@ export declare const empty: <A>() => STM.STM<TArray<A>>;
  * @category elements
  */
 export declare const every: {
+    /**
+     * Atomically evaluate the conjunction of a predicate across the members of
+     * the array.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(predicate: Predicate<A>): (self: TArray<A>) => STM.STM<boolean>;
+    /**
+     * Atomically evaluate the conjunction of a predicate across the members of
+     * the array.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(self: TArray<A>, predicate: Predicate<A>): STM.STM<boolean>;
 };
 /**
@@ -114,7 +198,21 @@ export declare const every: {
  * @category elements
  */
 export declare const everySTM: {
+    /**
+     * Atomically evaluate the conjunction of a transactional predicate across the
+     * members of the array.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A, R, E>(predicate: (value: A) => STM.STM<boolean, E, R>): (self: TArray<A>) => STM.STM<boolean, E, R>;
+    /**
+     * Atomically evaluate the conjunction of a transactional predicate across the
+     * members of the array.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A, R, E>(self: TArray<A>, predicate: (value: A) => STM.STM<boolean, E, R>): STM.STM<boolean, E, R>;
 };
 /**
@@ -124,7 +222,19 @@ export declare const everySTM: {
  * @category elements
  */
 export declare const findFirst: {
+    /**
+     * Find the first element in the array matching the specified predicate.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(predicate: Predicate<A>): (self: TArray<A>) => STM.STM<Option.Option<A>>;
+    /**
+     * Find the first element in the array matching the specified predicate.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(self: TArray<A>, predicate: Predicate<A>): STM.STM<Option.Option<A>>;
 };
 /**
@@ -134,7 +244,19 @@ export declare const findFirst: {
  * @category elements
  */
 export declare const findFirstIndex: {
+    /**
+     * Get the first index of a specific value in the array.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(value: A): (self: TArray<A>) => STM.STM<Option.Option<number>>;
+    /**
+     * Get the first index of a specific value in the array.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(self: TArray<A>, value: A): STM.STM<Option.Option<number>>;
 };
 /**
@@ -145,7 +267,21 @@ export declare const findFirstIndex: {
  * @category elements
  */
 export declare const findFirstIndexFrom: {
+    /**
+     * Get the first index of a specific value in the array starting from the
+     * specified index.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(value: A, from: number): (self: TArray<A>) => STM.STM<Option.Option<number>>;
+    /**
+     * Get the first index of a specific value in the array starting from the
+     * specified index.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(self: TArray<A>, value: A, from: number): STM.STM<Option.Option<number>>;
 };
 /**
@@ -155,7 +291,19 @@ export declare const findFirstIndexFrom: {
  * @category elements
  */
 export declare const findFirstIndexWhere: {
+    /**
+     * Get the index of the first entry in the array matching a predicate.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(predicate: Predicate<A>): (self: TArray<A>) => STM.STM<Option.Option<number>>;
+    /**
+     * Get the index of the first entry in the array matching a predicate.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(self: TArray<A>, predicate: Predicate<A>): STM.STM<Option.Option<number>>;
 };
 /**
@@ -166,7 +314,21 @@ export declare const findFirstIndexWhere: {
  * @category elements
  */
 export declare const findFirstIndexWhereFrom: {
+    /**
+     * Get the index of the first entry in the array starting from the specified
+     * index, matching a predicate.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(predicate: Predicate<A>, from: number): (self: TArray<A>) => STM.STM<Option.Option<number>>;
+    /**
+     * Get the index of the first entry in the array starting from the specified
+     * index, matching a predicate.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(self: TArray<A>, predicate: Predicate<A>, from: number): STM.STM<Option.Option<number>>;
 };
 /**
@@ -176,7 +338,19 @@ export declare const findFirstIndexWhereFrom: {
  * @category elements
  */
 export declare const findFirstIndexWhereSTM: {
+    /**
+     * Get the index of the next entry that matches a transactional predicate.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A, R, E>(predicate: (value: A) => STM.STM<boolean, E, R>): (self: TArray<A>) => STM.STM<Option.Option<number>, E, R>;
+    /**
+     * Get the index of the next entry that matches a transactional predicate.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A, R, E>(self: TArray<A>, predicate: (value: A) => STM.STM<boolean, E, R>): STM.STM<Option.Option<number>, E, R>;
 };
 /**
@@ -187,7 +361,21 @@ export declare const findFirstIndexWhereSTM: {
  * @category elements
  */
 export declare const findFirstIndexWhereFromSTM: {
+    /**
+     * Starting at specified index, get the index of the next entry that matches a
+     * transactional predicate.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A, R, E>(predicate: (value: A) => STM.STM<boolean, E, R>, from: number): (self: TArray<A>) => STM.STM<Option.Option<number>, E, R>;
+    /**
+     * Starting at specified index, get the index of the next entry that matches a
+     * transactional predicate.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A, R, E>(self: TArray<A>, predicate: (value: A) => STM.STM<boolean, E, R>, from: number): STM.STM<Option.Option<number>, E, R>;
 };
 /**
@@ -197,7 +385,19 @@ export declare const findFirstIndexWhereFromSTM: {
  * @category elements
  */
 export declare const findFirstSTM: {
+    /**
+     * Find the first element in the array matching a transactional predicate.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A, R, E>(predicate: (value: A) => STM.STM<boolean, E, R>): (self: TArray<A>) => STM.STM<Option.Option<A>, E, R>;
+    /**
+     * Find the first element in the array matching a transactional predicate.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A, R, E>(self: TArray<A>, predicate: (value: A) => STM.STM<boolean, E, R>): STM.STM<Option.Option<A>, E, R>;
 };
 /**
@@ -207,7 +407,19 @@ export declare const findFirstSTM: {
  * @category elements
  */
 export declare const findLast: {
+    /**
+     * Find the last element in the array matching a predicate.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(predicate: Predicate<A>): (self: TArray<A>) => STM.STM<Option.Option<A>>;
+    /**
+     * Find the last element in the array matching a predicate.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(self: TArray<A>, predicate: Predicate<A>): STM.STM<Option.Option<A>>;
 };
 /**
@@ -218,7 +430,21 @@ export declare const findLast: {
  * @category elements
  */
 export declare const findLastIndex: {
+    /**
+     * Get the last index of a specific value in the array bounded above by a
+     * specific index.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(value: A): (self: TArray<A>) => STM.STM<Option.Option<number>>;
+    /**
+     * Get the last index of a specific value in the array bounded above by a
+     * specific index.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(self: TArray<A>, value: A): STM.STM<Option.Option<number>>;
 };
 /**
@@ -229,7 +455,21 @@ export declare const findLastIndex: {
  * @category elements
  */
 export declare const findLastIndexFrom: {
+    /**
+     * Get the last index of a specific value in the array bounded above by a
+     * specific index.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(value: A, end: number): (self: TArray<A>) => STM.STM<Option.Option<number>>;
+    /**
+     * Get the last index of a specific value in the array bounded above by a
+     * specific index.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(self: TArray<A>, value: A, end: number): STM.STM<Option.Option<number>>;
 };
 /**
@@ -239,7 +479,19 @@ export declare const findLastIndexFrom: {
  * @category elements
  */
 export declare const findLastSTM: {
+    /**
+     * Find the last element in the array matching a transactional predicate.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A, R, E>(predicate: (value: A) => STM.STM<boolean, E, R>): (self: TArray<A>) => STM.STM<Option.Option<A>, E, R>;
+    /**
+     * Find the last element in the array matching a transactional predicate.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A, R, E>(self: TArray<A>, predicate: (value: A) => STM.STM<boolean, E, R>): STM.STM<Option.Option<A>, E, R>;
 };
 /**
@@ -249,7 +501,19 @@ export declare const findLastSTM: {
  * @category elements
  */
 export declare const forEach: {
+    /**
+     * Atomically performs transactional effect for each item in array.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A, R, E>(f: (value: A) => STM.STM<void, E, R>): (self: TArray<A>) => STM.STM<void, E, R>;
+    /**
+     * Atomically performs transactional effect for each item in array.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A, R, E>(self: TArray<A>, f: (value: A) => STM.STM<void, E, R>): STM.STM<void, E, R>;
 };
 /**
@@ -266,7 +530,19 @@ export declare const fromIterable: <A>(iterable: Iterable<A>) => STM.STM<TArray<
  * @category elements
  */
 export declare const get: {
+    /**
+     * Extracts value from ref in array.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     (index: number): <A>(self: TArray<A>) => STM.STM<A>;
+    /**
+     * Extracts value from ref in array.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(self: TArray<A>, index: number): STM.STM<A>;
 };
 /**
@@ -297,7 +573,19 @@ export declare const make: <Elements extends [any, ...Array<any>]>(...elements:
  * @category elements
  */
 export declare const maxOption: {
+    /**
+     * Atomically compute the greatest element in the array, if it exists.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(order: Order.Order<A>): (self: TArray<A>) => STM.STM<Option.Option<A>>;
+    /**
+     * Atomically compute the greatest element in the array, if it exists.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(self: TArray<A>, order: Order.Order<A>): STM.STM<Option.Option<A>>;
 };
 /**
@@ -307,7 +595,19 @@ export declare const maxOption: {
  * @category elements
  */
 export declare const minOption: {
+    /**
+     * Atomically compute the least element in the array, if it exists.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(order: Order.Order<A>): (self: TArray<A>) => STM.STM<Option.Option<A>>;
+    /**
+     * Atomically compute the least element in the array, if it exists.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(self: TArray<A>, order: Order.Order<A>): STM.STM<Option.Option<A>>;
 };
 /**
@@ -317,7 +617,19 @@ export declare const minOption: {
  * @category folding
  */
 export declare const reduce: {
+    /**
+     * Atomically folds using a pure function.
+     *
+     * @since 2.0.0
+     * @category folding
+     */
     <Z, A>(zero: Z, f: (accumulator: Z, current: A) => Z): (self: TArray<A>) => STM.STM<Z>;
+    /**
+     * Atomically folds using a pure function.
+     *
+     * @since 2.0.0
+     * @category folding
+     */
     <Z, A>(self: TArray<A>, zero: Z, f: (accumulator: Z, current: A) => Z): STM.STM<Z>;
 };
 /**
@@ -327,7 +639,19 @@ export declare const reduce: {
  * @category elements
  */
 export declare const reduceOption: {
+    /**
+     * Atomically reduce the array, if non-empty, by a binary operator.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(f: (x: A, y: A) => A): (self: TArray<A>) => STM.STM<Option.Option<A>>;
+    /**
+     * Atomically reduce the array, if non-empty, by a binary operator.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(self: TArray<A>, f: (x: A, y: A) => A): STM.STM<Option.Option<A>>;
 };
 /**
@@ -338,7 +662,21 @@ export declare const reduceOption: {
  * @category elements
  */
 export declare const reduceOptionSTM: {
+    /**
+     * Atomically reduce the non-empty array using a transactional binary
+     * operator.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A, R, E>(f: (x: A, y: A) => STM.STM<A, E, R>): (self: TArray<A>) => STM.STM<Option.Option<A>, E, R>;
+    /**
+     * Atomically reduce the non-empty array using a transactional binary
+     * operator.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A, R, E>(self: TArray<A>, f: (x: A, y: A) => STM.STM<A, E, R>): STM.STM<Option.Option<A>, E, R>;
 };
 /**
@@ -349,7 +687,21 @@ export declare const reduceOptionSTM: {
  * @category folding
  */
 export declare const reduceSTM: {
+    /**
+     * Atomically folds using a transactional function.
+     *
+     * @macro trace
+     * @since 2.0.0
+     * @category folding
+     */
     <Z, A, R, E>(zero: Z, f: (accumulator: Z, current: A) => STM.STM<Z, E, R>): (self: TArray<A>) => STM.STM<Z, E, R>;
+    /**
+     * Atomically folds using a transactional function.
+     *
+     * @macro trace
+     * @since 2.0.0
+     * @category folding
+     */
     <Z, A, R, E>(self: TArray<A>, zero: Z, f: (accumulator: Z, current: A) => STM.STM<Z, E, R>): STM.STM<Z, E, R>;
 };
 /**
@@ -366,7 +718,19 @@ export declare const size: <A>(self: TArray<A>) => number;
  * @category elements
  */
 export declare const some: {
+    /**
+     * Determine if the array contains a value satisfying a predicate.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(predicate: Predicate<A>): (self: TArray<A>) => STM.STM<boolean>;
+    /**
+     * Determine if the array contains a value satisfying a predicate.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(self: TArray<A>, predicate: Predicate<A>): STM.STM<boolean>;
 };
 /**
@@ -377,7 +741,21 @@ export declare const some: {
  * @category elements
  */
 export declare const someSTM: {
+    /**
+     * Determine if the array contains a value satisfying a transactional
+     * predicate.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A, R, E>(predicate: (value: A) => STM.STM<boolean, E, R>): (self: TArray<A>) => STM.STM<boolean, E, R>;
+    /**
+     * Determine if the array contains a value satisfying a transactional
+     * predicate.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A, R, E>(self: TArray<A>, predicate: (value: A) => STM.STM<boolean, E, R>): STM.STM<boolean, E, R>;
 };
 /**
@@ -395,7 +773,19 @@ export declare const toArray: <A>(self: TArray<A>) => STM.STM<Array<A>>;
  * @category elements
  */
 export declare const transform: {
+    /**
+     * Atomically updates all elements using a pure function.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(f: (value: A) => A): (self: TArray<A>) => STM.STM<void>;
+    /**
+     * Atomically updates all elements using a pure function.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(self: TArray<A>, f: (value: A) => A): STM.STM<void>;
 };
 /**
@@ -405,7 +795,19 @@ export declare const transform: {
  * @category elements
  */
 export declare const transformSTM: {
+    /**
+     * Atomically updates all elements using a transactional effect.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A, R, E>(f: (value: A) => STM.STM<A, E, R>): (self: TArray<A>) => STM.STM<void, E, R>;
+    /**
+     * Atomically updates all elements using a transactional effect.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A, R, E>(self: TArray<A>, f: (value: A) => STM.STM<A, E, R>): STM.STM<void, E, R>;
 };
 /**
@@ -415,7 +817,19 @@ export declare const transformSTM: {
  * @category elements
  */
 export declare const update: {
+    /**
+     * Updates element in the array with given function.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(index: number, f: (value: A) => A): (self: TArray<A>) => STM.STM<void>;
+    /**
+     * Updates element in the array with given function.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A>(self: TArray<A>, index: number, f: (value: A) => A): STM.STM<void>;
 };
 /**
@@ -425,7 +839,19 @@ export declare const update: {
  * @category elements
  */
 export declare const updateSTM: {
+    /**
+     * Atomically updates element in the array with given transactional effect.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A, R, E>(index: number, f: (value: A) => STM.STM<A, E, R>): (self: TArray<A>) => STM.STM<void, E, R>;
+    /**
+     * Atomically updates element in the array with given transactional effect.
+     *
+     * @since 2.0.0
+     * @category elements
+     */
     <A, R, E>(self: TArray<A>, index: number, f: (value: A) => STM.STM<A, E, R>): STM.STM<void, E, R>;
 };
 //# sourceMappingURL=TArray.d.ts.map