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

esr

v0.10.0

Published

Express-like Simple Router for client-side.

Downloads

457

Readme

English

Express-like Simple Router.

インストール

$ npm install --save esr

サンプル

import Esr from 'esr';

// インスタンス作成
const router = new Esr();

// ルーティング定義
const onEnter = function() {
  // URLが`/users`に変更された時の処理。
};
router.on('/users', onEnter);

// ルーティング監視開始
router.start();

// 別ページに遷移
router.navigateTo('/users');

コンストラクタ

インスタンス作成時に履歴管理方法を指定出来ます。

import Esr from 'esr';

// HTML5 history APIで履歴管理。
const router = new Esr(Esr.BROWSER);

// メモリ内で履歴管理。
const router = new Esr(Esr.MEMORY);

// ハッシュ(#)で履歴管理。
const router = new Esr(Esr.HASH);

デフォルトはEsr.BROWSERです。

詳細

ルーティング

router.navigateTo(String, Boolean)

指定URLにルーティングします。第二引数にtrueを渡すと強制的に画面遷移します。

import Esr from 'esr';
const router = new Esr();

router.navigateTo('/users');
router.navigateTo('/users/foo');
router.navigateTo('/users/foo?aaa=bbb');
router.navigateTo('/users/foo?aaa=bbb#ccc');
router.navigateTo('/users', true);

router.replace(String)

現在のURLを指定値に書き換えます。

import Esr from 'esr';
const router = new Esr();

router.replace('/users');

router.start(Boolean)

ルーティング監視を開始します。渡す引数によって、start時にpatternマッチを行うか否かが決定されます。デフォルトはtrueです。

import Esr from 'esr';
const router = new Esr();

router.on('/users', function(route) {
  console.log('users');
});

// 現在のURLが`https://sample.com/users`だと仮定する。
router.start();
//=> 'users'

router.on ルーティング定義

router.on(pattern, onEnter, onBefore, onAfter)でルーティング定義を行います。

pattern

type: String example: /users/:userid

マッチ対象のpathを指定します。

Expressスタイルで指定可能です。

import Esr from 'esr';
const router = new Esr();

router.on('/users', function() {
  console.log('users');
});
router.on('/users/:userid', function() {
  console.log('a user');
});
router.on('*', function() {
  console.log('not found');
});

router.navigateTo('/users');
//=> 'users'
router.navigateTo('/users/foo');
//=> 'a user'
router.navigateTo('/bar');
//=> 'not found'

詳細

onEnter

type: Function example: function(route)

URLがpatternにマッチした際に実行される関数を指定します。

import Esr from 'esr';
const router = new Esr();

router.on('/users/:userid', function(route) {
  console.log('a user');
});

router.navigateTo('/users/foo');
//=> 'a user';

route

onEnter実行時に様々な情報を格納したrouteオブジェクトが渡されます。

  • route.params(Object) patternに対応した値がkey-valueで設定されます。
  • route.queries(Object) クエリ値がkey-valueで設定されます。
  • route.hash(String) ハッシュ値が設定されます。
import Esr from 'esr';
const router = new Esr();

router.on('/users/:userid/:type', function(route) {
  // route.params.userid === 'foo';
  // route.params.type === 'bar';
  // route.queries.aaa === 'AAA';
  // route.queries.bbb === 'BBB';
  // route.hash === 'ccc';
});

router.navigateTo('/users/foo/bar?aaa=AAA&bbb=BBB#ccc');

onBefore

type: Function example: function(route, replace)

URLがpatternにマッチした際にonEnter直前に実行される関数を指定します。

route

onEnterrouteと同じです。

replace

onBefore実行時にリダイレクト用の関数が渡されます。

import Esr from 'esr';
const router = new Esr();

router.on('/aaa', function(route) {
  console.log('onEnter of /aaa');
}, function(route, replace) {
  console.log('onBefore of /aaa');
});

router.on('/bbb', function(route) {
  console.log('onEnter of /bbb');
});

router.navigateTo('/aaa');
//=> 'onBefore of /aaa'
//(=> 'onEnter of /bbb') <= this won't be logged.
//=> 'onEnter of /bbb'

onAfter

type: Function example: function(route)

URLがpatternにマッチした際にonEnter直後に実行される関数を指定します。

route

onEnterrouteと同じです。

共通ルーティング定義

router.onがマッチするpatternに対するルーティング定義を行うAPIであるのに対して、以下のAPIは全URLに対するルーティング定義を行います。

  • router.onBeforeOnce 一度だけrouter.on直前に発火します。
  • router.onBefore router.on直前に発火します。
  • router.onAfter router.on直後に発火します。
  • router.onAfterOnce 一度だけrouter.on直後に発火します。
import Esr from 'esr';
const router = new Esr();

router
  .onBeforeOnce(function(route) {
    console.log('before once');
  })
  .onBefore(function(route) {
    console.log('before');
  })
  .on('*', function(route) => {
    console.log('*');
  })
  .onAfter(function(route) {
    console.log('after');
  })
  .onAfterOnce(function(route) {
    console.log('after once');
  });

router.navigateTo('/first');
//=> 'before once'
//=> 'before'
//=> '*'
//=> 'after'
//=> 'after once'

router.navigateTo('/second');
//=> 'before'
//=> '*'
//=> 'after'

非同期処理

Promiseを返す関数をルーティング定義時に渡すことで非同期実行が可能になります。

import Esr from 'esr';
const router = new Esr();

router.on('/users',function(route) {
  console.log('onEnter');
  return new Promise(function(resolve) {
    window.setTimeout(function() {
      resolve();
    }, 1000);
  });
}, function(route, replace) {
  console.log('onBefore');
  return new Promise(function(resolve) {
    window.setTimeout(function() {
      resolve();
    }, 1000);
  });
}, function(route) {
  console.log('onAfter');
  return new Promise(function(resolve) {
    window.setTimeout(function() {
      resolve();
    }, 1000);
  });
}).onAfter(function(route) {
  console.log('complete!');
});

router.navigateto('/users');
//=> 'onBefore'
// wait for 1000ms...
//=> 'onEnter'
// wait for 1000ms...
//=> 'onAfter'
// wait for 1000ms...
//=> 'complete!'

テスト

$ npm run test

ビルド

$ npm run build

監視

$ npm run watch

リント

$ npm run lint