fix(join): setup the correct exports for join() operator

tusharmath · Sep 14, 2017 · 99fd510 · 99fd510
1 parent 2f4b23f
commit 99fd510
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 2 deletions.
diff --git a/API.md b/API.md
@@ -18,11 +18,12 @@
   - [never](#never)
 
 - [Operators](#operators)
-  - [concatMap](#concatMap)
   - [concat](#concat)
+  - [concatMap](#concatMap)
   - [delay](#delay)
   - [filter](#filter)
   - [flatMap](#flatMap)
+  - [join](#join)
   - [map](#map)
   - [mapTo](#mapTo)
   - [merge](#merge)
@@ -363,6 +364,21 @@ const $ = O.flatMap(
 )
 ```
 
+## join
+
+```ts
+function join(source: Observable): Observable
+```
+
+It is a special case of `flatMap` where the project function is identity
+
+**Example:**
+```ts
+const $ = O.join(
+  O.just(O.interval(1000))
+)
+```
+
 It is a special case of [mergeMap](#mergeMap) with concurrency set to `NUMBER.POSITIVE_INFINITY`.
 
 

diff --git a/src/main.ts b/src/main.ts
@@ -19,7 +19,7 @@ export {IObserver} from './lib/Observer'
 export {IScheduler} from './lib/Scheduler'
 export {ISubscriberFunction} from './lib/SubscriberFunction'
 export {ISubscription} from './lib/Subscription'
-export {join} from './operators/Join'
+export {join} from './operators/MergeMap'
 export {just} from './sources/Create'
 export {mapTo} from './operators/Map'
 export {map} from './operators/Map'