/xstream-router5

xstream plugin for router5 [MOVED]

Primary LanguageJavaScriptMIT LicenseMIT

Moved to router5 repository

npm version

xstream-router5

xstream integration with router5

npm install --save xstream-router5

Usage

xstream-router5 exports a single function createObservables:

import createRouter from 'router5';
import createObservables from 'xstream-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 route
  • transitionRoute$: an observable of the currently transitioning route
  • transitionError$: an observable of transition errors
  • routeNode(nodeName = ''): a function returning an observable of route updates for the specified node. See understanding router5.

Related