withObservables

A higher-order component for connecting RxJS Observables to React components.

Example

(Taken from WatermelonDB)

``js
const Post = ({ post, comments }) => (


const EnhancedPost = enhance(Post)
`

➡️ Learn more: Connecting WatermelonDB to Components

Installation

`bash
yarn add @nozbe/with-observables
`

And then to use:

`js
import withObservables from '@nozbe/with-observables'
`

Usage

`js
withObservables(triggerProps, getObservables)

// Injects new props to a component with values from the passed Observables
//
// Every time one of the triggerProps changes, getObservables() is called
// and the returned Observables are subscribed to.
//
// Every time one of the Observables emits a new value, the matching inner prop is updated.
//
// You can return multiple Observables in the function. You can also return arbitrary objects that have
// an observe() function that returns an Observable.
//
// The inner component will not render until all supplied Observables return their first values.
// If triggerProps change, renders will also be paused until the new Observables emit first values.
//
// If you only want to subscribe to Observables once (the Observables don't depend on outer props),
// pass null to triggerProps.
//
// Errors are re-thrown in render(). Use React Error Boundary to catch them.
//
// Example use:
// withObservables(['task'], ({ task }) => ({
// task: task,
// comments: task.comments.observe()
// }))
`

Typescript

The TypeScript bindings expose a helper type, ObservableifyProps which can make it easier to wrap components without duplicating interfaces:
`ts
interface Props {
post: Post;
author: Author;
someOtherProp: boolean;
anotherProp: number;
}

const PostRenderer: React.FC = (props) => ( ... );

type InputProps = ObservableifyProps
const enhance = withObservables(["post", "author"], ({ post }: InputProps) => ({
post,
author: author.observe()
});

export default enhance(PostRenderer);
`

Or you can let getObservables define your props for you:
`tsx
import withObservables, {ExtractedObservables} from "@nozbe/with-observables"

const getObservables = ({ post }: { post: Post }}) => ({
post,
author: author.observe()
});

interface Props extends ExtractedObservables> {
someOtherProp: boolean;
anotherProp: number;
}

const PostRenderer: React.FC = (props) => (
<>{props.author.id}
);

export default withObservables(["post"], getObservables)(PostRenderer);
``

Author and license

withObservables was created by @Nozbe for WatermelonDB.

withObservables' main author and maintainer is Radek Pietruszewski (website ⋅ twitter ⋅ engineering posters)

See all contributors.

withObservables is available under the MIT license. See the LICENSE file for more info.