Resubscribe NPM

Resubscribe

Resubscribe is a React utility that renders asynchronous values.

Installation

npm install resubscribe

Supported Concepts

The following asynchronous concepts are supported out-of-the-box:

Usage

This section contains usage examples for Resubscribe. You can also have a look at the unit tests for more details.

The <Subscribe />-component needs a source to subscribe to - whch can be anything listed here - and a render function (as children) to display the obtained values.

<Subscribe to={source}>
  {value => <div>{value}</div>}
</Subscribe>

With Promises

Renders as soon as the promise resolves.

const promise = Promise.resolve('foo')

// renders <div>foo</div>
<Subscribe to={promise}>
  {value => <div>{value}</div>}
</Subscribe>

With Observables

Renders the most recent value emitted by the observable.

This example uses rxjs, but other Observable libraries should work as well.

import { Observable } from 'rxjs'

const observable = Observable.timer(0, 1000)

// renders <div>X</div>
// X starts at 0 and is incremented every second
<Subscribe to={observable}>
  {value => <div>{value}</div>}
</Subscribe>

With Async Iterators

Renders the most recent value obtained from the async iterator.

const asyncIterator = (async function*() {
  let x = 0
  while (true) {
    yield x++
    // sleep for one second
    await new Promise(resolve => setTimeout(resolve, 1000))
  }
})

// renders <div>X</div>
// X starts at 0 and is incremented every second
<Subscribe to={asyncIterator}>
  {value => <div>{value}</div>}
</Subscribe>

With Synchronous Values

Renders the value synchronously.

// renders <div>foo</div>
<Subscribe to={'foo'}>
  {value => <div>{value}</div>}
</Subscribe>

Non-ideal States

By default, nothing is rendered when no value has been obtained yet or as soon as an error occurs. This behavior can be customized by passing a renderer object instead of a render function.

const promise = new Promise((resolve, reject) => {
  setTimeout(() => reject(new Error('failed')), 1000)
})

// renders 'loading' and then 'error: failed' after one second
<Subscribe to={promise}>
  {{
    loading: () => 'loading',
    next: value => 'value: ' + value,
    error: err => 'error: ' + err.message,
  }}
</Subscribe>

const promise = new Promise((resolve, reject) => {
  setTimeout(() => resolve('value', 1000)
})

// renders 'loading' and then 'value' after one second
<Subscribe to={promise} placeholder={'loading'} />

All renderer methods are optional and have the following defaults: