npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

yameee-router

v2.0.1

Published

Yet another MobX router

Downloads

5

Readme

mobx-little-router

This package provides the core functionality of the MobX little router.

Getting Started

Import the install function from package, along with your chosen history creator from history package.

import { install } from 'yameee-router'
import { createMemoryHistory } from 'history'

const ROUTES = [{ path: ':whatever' }]

const router = install({
  history: createMemoryHistory(),
  routes: ROUTES
})

Then run router.start(...) which takes in a callback when initialization finishes.

import { autorun } from 'mobx'

router.start(() => {
  autorun(() => console.log(`path = ${router.store.location.pathname}`))

  router.push('/a') // Prints "path = /a/"
  router.push('/b') // Prints "path = /b/"
  router.push('/c') // Prints "path = /c/"

  router.push('/not/found') // Navigation aborts since path cannot be matched from config.
})

Install options

The install function takes the following options:

  • history - The history object created from history.

  • getContext - A function that returns a context object that is accessible from each route. This is useful for sharing MobX stores or other injectable objects.

  • middleware - Custom router middleware for your application.

  • routes - A list of initial route configuration of type Config[], where

    type Config = {
      path: string,
    
      // Static child routes.
      children?: Config[],
    
      // Dynamic child routes
      loadChildren?: () => Promise<Config[]>,
    
      // Guard functions that can block a route from activating or deactivating.
      canActivate?: (route: Route<*, *>) => boolean | Promise<void>,
      canDeactivate?: (route: Route<*, *>) => boolean | Promise<void>,
    
      // Called for each activation or query/param changes to the route.
      // Used for resolving effects.
      willResolve?: (route: Route<*, *>) => Promise<void>,
    
      onTransition?: (evt: TransitionEvent) => Promise<void>
    }

    For more type information, check out the routing/types.js file.

Documentation