renamed to mergeWithTag

Effect-TS · Sep 30, 2024 · a04169d · a04169d
1 parent ecad546
commit a04169d
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 9 deletions.
diff --git a/.changeset/silver-tools-collect.md b/.changeset/silver-tools-collect.md
@@ -2,15 +2,15 @@
 "effect": patch
 ---
 
-added Stream.mergeStruct
+added Stream.mergeWithTag
 
 Combines a struct of streams into a single stream of tagged values where the tag is the key of the struct.
 
 ```ts
 import { Stream } from "effect"
 
 // Stream.Stream<{ _tag: "a"; value: number; } | { _tag: "b"; value: string; }>
-const stream = Stream.mergeStruct(
+const stream = Stream.mergeWithTag(
   {
     a: Stream.make(0),
     b: Stream.make("")

diff --git a/packages/effect/dtslint/Stream.ts b/packages/effect/dtslint/Stream.ts
@@ -256,7 +256,7 @@ Stream.zipLatestAll(numbers, numbersOrStrings, Stream.fail(new Error("")))
 // -------------------------------------------------------------------------------------
 
 // $ExpectType Stream<{ _tag: "a"; value: number; } | { _tag: "b"; value: string; }, NoSuchElementException, never>
-Stream.mergeStruct({
+Stream.mergeWithTag({
   a: Stream.make(0).pipe(Stream.tap(() => new Cause.NoSuchElementException())),
   b: Stream.make("")
 }, { concurrency: 1 })
diff --git a/packages/effect/src/Stream.ts b/packages/effect/src/Stream.ts
@@ -2902,12 +2902,12 @@ export const mergeAll: {
  *
  * @example
  * // Stream.Stream<{ _tag: "a"; value: number; } | { _tag: "b"; value: string; }>
- * const res = mergeStruct({
+ * const res = mergeWithTag({
  *    a: Stream.make(0),
  *    b: Stream.make("")
  * })
  */
-export const mergeStruct: {
+export const mergeWithTag: {
   <S extends { [k in string]: Stream<any, any, any> }>(
     streams: S,
     options: {
@@ -2927,7 +2927,7 @@ export const mergeStruct: {
     Stream.Error<S[keyof S]>,
     Stream.Context<S[keyof S]>
   >
-} = internal.mergeStruct
+} = internal.mergeWithTag
 
 /**
  * Merges this stream and the specified stream together to a common element

diff --git a/packages/effect/src/internal/stream.ts b/packages/effect/src/internal/stream.ts
@@ -4108,7 +4108,7 @@ export const mergeAll = dual<
 >((args) => Symbol.iterator in args[0], (streams, options) => flatten(fromIterable(streams), options))
 
 /** @internal */
-export const mergeStruct: {
+export const mergeWithTag: {
   <S extends { [k in string]: Stream.Stream<any, any, any> }>(
     streams: S,
     options: {

diff --git a/packages/effect/test/Stream/merging.test.ts b/packages/effect/test/Stream/merging.test.ts
@@ -38,9 +38,9 @@ describe("Stream", () => {
       assert.deepStrictEqual(Array.from(result), [1])
     }))
 
-  it.effect("mergeStruct", (ctx) =>
+  it.effect("mergeWithTag", (ctx) =>
     Effect.gen(function*() {
-      const stream = Stream.mergeStruct({
+      const stream = Stream.mergeWithTag({
         a: Stream.make(0),
         b: Stream.make("")
       }, { concurrency: 1 })