feat: remove mapObs

BREAKING CHANGE: `mapObs` is removed and remplaced by `withObs`
gregberge · Apr 25, 2017 · 53e5c5f · 53e5c5f
1 parent 74b3744
commit 53e5c5f
Show file tree

Hide file tree

Showing 4 changed files with 2 additions and 88 deletions.
diff --git a/src/__tests__/mapObs.test.js b/src/__tests__/mapObs.test.js
diff --git a/src/index.js b/src/index.js
@@ -19,7 +19,6 @@ import isClassComponent from './isClassComponent'
 import isReferentiallyTransparentFunctionComponent
   from './isReferentiallyTransparentFunctionComponent'
 import lifecycle from './lifecycle'
-import mapObs from './mapObs'
 import mapProps from './mapProps'
 import mapPropsStream from './mapPropsStream'
 import nest from './nest'
@@ -70,7 +69,6 @@ export {
   isClassComponent,
   isReferentiallyTransparentFunctionComponent,
   lifecycle,
-  mapObs,
   mapProps,
   mapPropsStream,
   nest,
@@ -122,7 +120,6 @@ export default {
   isClassComponent,
   isReferentiallyTransparentFunctionComponent,
   lifecycle,
-  mapObs,
   mapProps,
   mapPropsStream,
   nest,

diff --git a/src/mapObs.js b/src/mapObs.js
diff --git a/src/withObs.js b/src/withObs.js
@@ -4,7 +4,8 @@ import shareObservable from './utils/shareObservable'
 import createHelper from './createHelper'
 
 /**
- * Similar to `mapObs` except that observables will be merged to the previous ones.
+ * Takes observables from the context and special observable `props$` an map them
+ * to a new set of observables.
  *
  * @static
  * @category Higher-order-components