Add more previously known as (#1000)

Author: tim-smart

packages/effect/src/Effect.ts

@@ -2007,6 +2007,12 @@ export const tap: {
  * The resulting effect cannot fail directly because all recoverable failures
  * are represented inside the `Result` type.
  *
+ * **Previously Known As**
+ *
+ * This API replaces the following from Effect 3.x:
+ *
+ * - `Effect.either`
+ *
  * @example
  * ```ts
  * import { Effect } from "effect"
@@ -2972,6 +2978,12 @@ export const catchIf: {
  * function doesn't alter the error type, so the resulting effect still carries
  * the original error type unless a type-guarding filter narrows the type.
  *
+ * **Previously Known As**
+ *
+ * This API replaces the following from Effect 3.x:
+ *
+ * - `Effect.catchSome`
+ *
  * @example
  * ```ts
  * import { Effect, Filter } from "effect"
@@ -3009,6 +3021,12 @@ export const catchFilter: {
  * that match a specific predicate. This is useful when you want to handle
  * only certain types of errors while letting others propagate.
  *
+ * **Previously Known As**
+ *
+ * This API replaces the following from Effect 3.x:
+ *
+ * - `Effect.catchSomeCause`
+ *
  * @example
  * ```ts
  * import { Cause, Console, Effect } from "effect"
@@ -3282,6 +3300,12 @@ export const tapErrorTag: {
  * whether it's a failure, defect, or other exceptional conditions, without
  * altering the error or the overall result of the effect.
  *
+ * **Previously Known As**
+ *
+ * This API replaces the following from Effect 3.x:
+ *
+ * - `Effect.tapErrorCause`
+ *
  * @example
  * ```ts
  * import { Cause, Console, Effect } from "effect"

packages/effect/src/Stream.ts

@@ -308,6 +308,12 @@ export const fromEffectDrain = <A, E, R>(effect: Effect.Effect<A, E, R>): Stream
   fromPull(Effect.succeed(Effect.flatMap(effect, () => Cause.done())))
 
 /**
+ * **Previously Known As**
+ *
+ * This API replaces the following from Effect 3.x:
+ *
+ * - `Stream.repeatEffect`
+ *
  * @since 4.0.0
  * @category constructors
  */
@@ -318,6 +324,12 @@ export const fromEffectRepeat = <A, E, R>(effect: Effect.Effect<A, E, R>): Strea
  * Creates a stream from an effect producing a value of type `A`, which is
  * repeated using the specified schedule.
  *
+ * **Previously Known As**
+ *
+ * This API replaces the following from Effect 3.x:
+ *
+ * - `Stream.repeatEffectWithSchedule`
+ *
  * @since 2.0.0
  * @category constructors
  */
@@ -478,6 +490,15 @@ export const toChannel = <A, E, R>(
  * You can customize the buffer size and strategy by passing an object as the
  * second argument with the `bufferSize` and `strategy` fields.
  *
+ * **Previously Known As**
+ *
+ * This API replaces the following from Effect 3.x:
+ *
+ * - `Stream.async`
+ * - `Stream.asyncEffect`
+ * - `Stream.asyncPush`
+ * - `Stream.asyncScoped`
+ *
  * @example
  * ```ts
  * import { Effect, Queue, Stream } from "effect"
@@ -776,6 +797,12 @@ export const fromIterableEffectRepeat = <A, E, R>(
  * This function creates a Stream that emits all values from the provided array.
  * If the array is empty, it returns an empty Stream.
  *
+ * **Previously Known As**
+ *
+ * This API replaces the following from Effect 3.x:
+ *
+ * - `Stream.fromChunk`
+ *
  * @example
  * ```ts
  * import { Effect, Stream } from "effect"
@@ -808,6 +835,12 @@ export const fromArrayEffect = <A, E, R>(
 /**
  * Creates a stream from some ararys.
  *
+ * **Previously Known As**
+ *
+ * This API replaces the following from Effect 3.x:
+ *
+ * - `Stream.fromChunks`
+ *
  * @since 4.0.0
  * @category constructors
  */
@@ -1297,6 +1330,12 @@ export const mapBoth: {
   ))
 
 /**
+ * **Previously Known As**
+ *
+ * This API replaces the following from Effect 3.x:
+ *
+ * - `Stream.mapChunks`
+ *
  * @since 2.0.0
  * @category mapping
  */
@@ -1398,6 +1437,12 @@ export const flattenEffect: {
 ): Stream<A, EX | E, RX | R> => mapEffect(self, identity, options))
 
 /**
+ * **Previously Known As**
+ *
+ * This API replaces the following from Effect 3.x:
+ *
+ * - `Stream.mapChunksEffect`
+ *
  * @since 4.0.0
  * @category mapping
  */
@@ -1721,6 +1766,12 @@ export const flatten: {
 /**
  * Flattens a stream of non-empty arrays into a single stream.
  *
+ * **Previously Known As**
+ *
+ * This API replaces the following from Effect 3.x:
+ *
+ * - `Stream.flattenChunks`
+ *
  * @since 4.0.0
  * @category sequencing
  */
@@ -1892,6 +1943,12 @@ export const forever = <A, E, R>(self: Stream<A, E, R>): Stream<A, E, R> => from
 /**
  * Flattens a stream of iterables into a single stream.
  *
+ * **Previously Known As**
+ *
+ * This API replaces the following from Effect 3.x:
+ *
+ * - `Stream.flattenIterables`
+ *
  * @since 4.0.0
  * @category sequencing
  */
@@ -2187,6 +2244,12 @@ const zipArrays = <AL, AR, A>(
  * Zips this stream with another stream using a function that operates on arrays
  * (chunks) of elements rather than individual elements.
  *
+ * **Previously Known As**
+ *
+ * This API replaces the following from Effect 3.x:
+ *
+ * - `Stream.zipWithChunks`
+ *
  * @since 2.0.0
  * @category zipping
  */
@@ -3123,6 +3186,12 @@ export const buffer: {
  * Allows a faster producer to progress independently of a slower consumer by
  * buffering up to `capacity` elements in a queue.
  *
+ * **Previously Known As**
+ *
+ * This API replaces the following from Effect 3.x:
+ *
+ * - `Stream.bufferChunks`
+ *
  * @since 2.0.0
  * @category utils
  */
@@ -3151,6 +3220,12 @@ export const bufferArray: {
 /**
  * Handles stream failures by examining the full Cause of failure.
  *
+ * **Previously Known As**
+ *
+ * This API replaces the following from Effect 3.x:
+ *
+ * - `Stream.catchAllCause`
+ *
  * @example
  * ```ts
  * import { Effect, Stream } from "effect"
@@ -3189,6 +3264,12 @@ export const catchCause: {
   ))
 
 /**
+ * **Previously Known As**
+ *
+ * This API replaces the following from Effect 3.x:
+ *
+ * - `Stream.tapErrorCause`
+ *
  * @since 4.0.0
  * @category Error handling
  */
@@ -3224,6 +3305,12 @@ const catch_: {
 
 export {
   /**
+   * **Previously Known As**
+   *
+   * This API replaces the following from Effect 3.x:
+   *
+   * - `Stream.catchAll`
+   *
    * @since 4.0.0
    * @category Error handling
    */
@@ -3252,6 +3339,12 @@ export const tapError: {
   ))
 
 /**
+ * **Previously Known As**
+ *
+ * This API replaces the following from Effect 3.x:
+ *
+ * - `Stream.catchSome`
+ *
  * @since 4.0.0
  * @category Error handling
  */
@@ -3400,6 +3493,12 @@ export const mapError: {
 /**
  * Conditionally handles stream failures based on a predicate applied to the Cause.
  *
+ * **Previously Known As**
+ *
+ * This API replaces the following from Effect 3.x:
+ *
+ * - `Stream.catchSomeCause`
+ *
  * @example
  * ```ts
  * import { Cause, Stream } from "effect"
@@ -4306,6 +4405,12 @@ export const combine: {
  * some internal state to control the combining process, with the initial
  * state being specified by `s`.
  *
+ * **Previously Known As**
+ *
+ * This API replaces the following from Effect 3.x:
+ *
+ * - `Stream.combineChunks`
+ *
  * @since 2.0.0
  * @category utils
  */
@@ -6568,6 +6673,12 @@ export const runLast = <A, E, R>(self: Stream<A, E, R>): Effect.Effect<Option.Op
  * Consumes all elements of the stream, passing them to the specified
  * callback.
  *
+ * **Previously Known As**
+ *
+ * This API replaces the following from Effect 3.x:
+ *
+ * - `Stream.runForEachChunk`
+ *
  * @example
  * ```ts
  * import { Console, Effect, Stream } from "effect"