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

@yiotis/easyroutes

v1.0.0

Published

Effortless management of named routes for JavaScript applications

Downloads

6

Readme

easyroutes

Build Status

Description

easyroutes is an easy, uncomplicated package that helps you maintain named routes and construct them with parameters, a search string and/or a hash with a straightfoward API.

It can be used in combination with any JavaScript router (e.g. React Router).

Getting started

These instructions will get you read to start defining your routes.

Contents:

Installing

With NPM: npm install --save @yiotis/easyroutes

With Yarn: yarn add @yiotis/easyroutes

Usage

Instantiate a routes map

Let's imagine that we need to define routes for a module named posts, resembling the posts of a blog. We start by creating an easyroutes instance. Which we can then export, to reuse later.

const postsRoutes = new EasyRoutes({
  newPost: '/post/new',
  post: '/post/:id',
});

export default postRoutes;

Defining new routes

Once you have an easyroutes instance, you can then import it from any other module and add more routes to it. Simply invoke it providing an object of routes.

import postRoutes from './postRoutes';

postRoutes({
  deletedPosts: '/deleted-posts',
  user: {
    posts: '/user/:id/posts', // use :parameter to define a parameter
  },
});

This will merge the new routes into the router. Keep in mind that trying to overwrite an old route will result in an exception.

Interpolating a route

To output a route you simply need to invoke your easyroutes instance with the key to your route.

const deletedPostsRoute = postRoutes('deletedPosts'); // will output '/deleted-posts'

To interpolate a route with parameters you need to pass an object with the key as the parameter name and a value.

// will output '/user/xkai3jasivn/posts'
const userPostsRoute = postRoutes('user.posts', {
  id: 'xkai3jasivn',
});

If you don't define values for all parameters, easyroutes will throw an exception.

Adding a search string and/or a hash

Sometimes you might need a search string and/or a hash added to your route. In this case you can build a route passing in an object of options as follows.

// will output '/user/xkai3jasivn/posts?q=old#heading
const userPostsRoute = postRoutes('user.posts', {
  params: {
    id: 'xkai3jasivn',
  },
  search: {
    q: 'old',
  },
  hash: '#heading',
});

The search could also have been a string so the previous example could be rewritten as:

// will output '/user/xkai3jasivn/posts?q=old#heading
const userPostsRoute = postRoutes('user.posts', {
  params: {
    id: 'xkai3jasivn',
  },
  search: '?q=old',
  hash: '#heading',
});

Versioning

SemVer is used for the versioning of this project.

License

Project is licensed under MIT. Check the License file for more.