React Native Offline Versions Save

Fixes a peer dependency issue with [email protected]

• Adds support for [email protected]
• Web support

Added useIsConnected hook

What's new

• Support for custom headers when pinging your own server

TypeScript Support 🚀

Rewriting the library with Typescript + exporting types to consumers

Offline queue semaphore

Adds a mechanism control for the offline queue, in order to decide when to release it.

For that, createNetworkMiddleware now receives a new optional parameter, shouldDequeueSelector. See more here

This release exposes a new api, createReducer, that allows you to customise the way the offline queue handles duplicates.

New features

createNetworkMiddleware

A new optional parameter has been added, queueReleaseThrottle. It allows you to interval the dispatches when flushing the offline queue. It defaults to 50ms.

• Fixes bug on iOS on checkInternetConnection
• Added a 3rd optional parameter: shouldPing
• Added documentation around it

Summary

This release is a full-blown refactor of the library, where some of the core components have been re-written from scratch, providing a better modularity, using the latest React features and adopting a TDD strategy, where all the code is unit tested to facilitate external contributions in the future.

Added

• Full feature parity between components and sagas
• 100% unit test coverage in components, redux utilities and sagas

Breaking changes

Components

• withNetworkConnectivity HOC has been replaced with NetworkProvider and NetworkConsumer components, that leverage the new React Context API.
• The following props/config have changed:
  • timeout -> pingTimeout
  • withExtraHeadRequest -> shouldPing
  • checkConnectionInterval -> pingInterval
  • checkIntervalOfflineOnly -> pingOnlyIfOffline
  • checkInBackground -> pingInBackground
• ConnectivityRenderer doesn't exist anymore. Use NetworkConsumer from now on.

Redux integration

• withNetworkConnectivity({ withRedux: true }) has been replaced with ReduxNetworkProvider component.
• ReduxNetworkProvider receives the same props as NetworkProvider to configure the behaviour.
• 2nd step (saga integration): networkEventsListenerSaga has been renamed to networkSaga.

Utilities

• checkInternetConnection Function params order has been reversed. Now 1st argument is the url and 2nd the timeout.