rxjs-router5
v8.0.1
Published
RxJS plugin for router5
Downloads
12
Maintainers
Readme
rxjs-router5
rxjs (RxJS 5+) integration with router5
npm install --save rxjs-router5
Usage
rxjs-router5 exports a single function createObservables
:
import createRouter from 'router5';
import createObservables from 'rxjs-router5';
const router = createRouter([
{ name: 'home', path: '/home' },
{ name: 'about', path: '/about' }
]);
const {
route$,
routeNode,
transitionError$,
transitionRoute$
} = createObservables(router)
router.start();
route$.map((route) => { /* ... */ })
Available observables
createObservables
returns the following observables:
route$
: an observable of your application routetransitionRoute$
: an observable of the currently transitioning routetransitionError$
: an observable of transition errorsrouteNode(nodeName)
: a function returning an observable of route updates for the specified node.