API changes

[lilactown]

Proposal 1: observeComponent returns observable

Right now, creating the ObservableComponent and obtaining the observable attached to the component is done in two steps:

// create observable component
const MyComponent = observeComponent('div')('onClick');

// obtain the observable attached to it
const myObs$ = fromComponent(MyComponent);

observeComponent could be changed to instead return both the component we are observing, as well as the observable attached:

const { component, observable } = observeComponent('div')('onClick');

This would remove the need for fromComponent, however it would require users to use object destructuring and renaming:

const {
  component: MyComponent,
  observable: myObs$,
} = observeComponent('div')('onClick');

const {
  component: OtherComponent,
  observable: otherObs$
} = observeComponent('input')('onChange');

It could also be done by returning an array instead of an object to avoid the verbosity of renaming the object properties:

const [MyComponent, myObs$] = observeComponent('div')('onClick');

However, this would be less ergonomic for people who may be utilizing this library without es2015+.

Pros:

• Reduces API surface (only one function!)
• Removes the need to mutate the wrapped React component by attaching the observable as a property
• Removes fromComponent function, which is slightly redundant and potentially confusing to new users.

Cons:

• Relies on ES2015+ syntax to be really ergonomic
• Would be a breaking change
• Loses similarity to obtaining observables from other event-producing objects in most libraries (Rx.Observable.from(), Kefir.fromCallback/fromEvents/fromPoll, etc...)