{"_id":"ways","_rev":"49-6c48bc130fc025517aea0a8d02797bbf","name":"ways","description":"Fluid router specially designed for complex page transitions and granular UI animations","dist-tags":{"latest":"0.5.0"},"versions":{"0.2.0":{"name":"ways","version":"0.2.0","author":{"name":"Anderson Arboleya","email":"anderson@arboleya.me"},"description":"Micro router with flow-based navigation mechanism and middlewares support","keywords":["router","navigation","flow"],"main":"./lib/ways","scripts":{"test":"make test"},"directories":{"src":"./src"},"repository":{"type":"git","url":"http://github.com/serpentem/ways"},"engines":{"node":">= 0.10"},"dependencies":{"happens":"0.3.x"},"devDependencies":{"coffee-script":"1.6.x","chai":"1.8.x","mocha":"1.14.x","mversion":"0.2.x","istanbul":"0.1.x","coveralls":"2.3.x"},"bugs":{"url":"https://github.com/serpentem/ways/issues"},"_id":"ways@0.2.0","dist":{"shasum":"dfba8afebf5e45866f0be5137b07b39ba1d6837a","tarball":"https://registry.npmjs.org/ways/-/ways-0.2.0.tgz","integrity":"sha512-CVmlxhVrSDhIJiOmsVkqdCkr6HIGCV5XzBLw3UECCQ/Ao+aIbKejj3Js60HRfFJmQmroSxOsJuEffdxByUDzpA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDb248yoO+bLx1lg3C03oerHG/8B0D3s3SfEij+TyQrmQIgejXf+us3474rbDpKWz3854gHw8rP1CpGbi4qbCqN5N4="}]},"_from":".","_npmVersion":"1.2.32","_npmUser":{"name":"arboleya","email":"anderson@arboleya.me"},"maintainers":[{"name":"arboleya","email":"anderson@arboleya.me"}]},"0.2.1":{"name":"ways","version":"0.2.1","author":{"name":"Anderson Arboleya","email":"anderson@arboleya.me"},"description":"Micro router with flow-based navigation mechanism and middlewares support","keywords":["router","navigation","flow"],"main":"./lib/ways","scripts":{"test":"make test"},"directories":{"src":"./src"},"repository":{"type":"git","url":"http://github.com/serpentem/ways"},"engines":{"node":">= 0.10"},"dependencies":{"happens":"0.3.x"},"devDependencies":{"coffee-script":"1.6.x","chai":"1.8.x","mocha":"1.14.x","mversion":"0.2.x","istanbul":"0.1.x","coveralls":"2.3.x"},"bugs":{"url":"https://github.com/serpentem/ways/issues"},"_id":"ways@0.2.1","dist":{"shasum":"1bf4aa3f02df411ae0b1e5a273172563d4cac875","tarball":"https://registry.npmjs.org/ways/-/ways-0.2.1.tgz","integrity":"sha512-f7RZWAxjOLF6yTI3g+gn9Ieus0ZmMNsjjrj8nzx6T13taOBp8+tIhyuKS5Wu70W4zSfEA17OIdS5adLz+bGyVg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHENbKQsbXfba6xBl+p+e32vCubqr+63y1owhWFhegJGAiEAmBEhf11AXCWYo7bA7fZzrEpx9h5Ct7lbfPWQvwi1Auc="}]},"_from":".","_npmVersion":"1.2.32","_npmUser":{"name":"arboleya","email":"anderson@arboleya.me"},"maintainers":[{"name":"arboleya","email":"anderson@arboleya.me"}]},"0.2.2":{"name":"ways","version":"0.2.2","author":{"name":"Anderson Arboleya","email":"anderson@arboleya.me"},"description":"Micro router with flow-based navigation mechanism and middlewares support","keywords":["router","navigation","flow"],"main":"./lib/ways","scripts":{"test":"make test"},"directories":{"src":"./src"},"repository":{"type":"git","url":"http://github.com/serpentem/ways"},"engines":{"node":">= 0.10"},"dependencies":{"happens":"0.3.x"},"devDependencies":{"coffee-script":"1.6.x","chai":"1.8.x","mocha":"1.14.x","mversion":"0.2.x","istanbul":"0.1.x","coveralls":"2.3.x"},"bugs":{"url":"https://github.com/serpentem/ways/issues"},"_id":"ways@0.2.2","dist":{"shasum":"b520d2227149831e32e5fc350fed4748c315e881","tarball":"https://registry.npmjs.org/ways/-/ways-0.2.2.tgz","integrity":"sha512-XXMZk8GcW3zn2slHiioC3Hg9C8ghZCoFIrjWzxJWwx7NPcZnpa1xC6rA+1zAqOPQbyFATnFdUSWx2iM4D6NiiA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDTiBj+8IWerq9AE6+oFgBSEPNRwQyTEJvm4Ku3vnUmUAiEA9rNUeXwZ5YPrfIZN+/yL4WAz3osdKW20tDAZC5IWvDI="}]},"_from":".","_npmVersion":"1.2.32","_npmUser":{"name":"arboleya","email":"anderson@arboleya.me"},"maintainers":[{"name":"arboleya","email":"anderson@arboleya.me"}]},"0.2.3":{"name":"ways","version":"0.2.3","author":{"name":"Anderson Arboleya","email":"anderson@arboleya.me"},"description":"Micro router with flow-based navigation mechanism and middlewares support","keywords":["router","navigation","flow"],"main":"./lib/ways","scripts":{"test":"make test"},"directories":{"src":"./src"},"repository":{"type":"git","url":"http://github.com/serpentem/ways"},"engines":{"node":">= 0.10"},"dependencies":{"happens":"0.3.x"},"devDependencies":{"coffee-script":"1.6.x","chai":"1.8.x","mocha":"1.14.x","mversion":"0.2.x","istanbul":"0.1.x","coveralls":"2.3.x"},"bugs":{"url":"https://github.com/serpentem/ways/issues"},"_id":"ways@0.2.3","dist":{"shasum":"b02f1db363bfa9cd0f5515958cc00880e4a786b1","tarball":"https://registry.npmjs.org/ways/-/ways-0.2.3.tgz","integrity":"sha512-wyf8IJlu0PX2tsHnrdiztK6L8gufp/bXZej48ZPvusJ8Rqtm9n7SBLo/vQEC/C0g1te+eivD3fdsHjxJUTr+rA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBIYISzgvSulaisnpPUcgBw6EjW7xqECgrxkh9Ask2trAiBFjF/yHEPE8sNCeOSqHKm4love3f+3ZuHGgxsyZ150cw=="}]},"_from":".","_npmVersion":"1.2.32","_npmUser":{"name":"arboleya","email":"anderson@arboleya.me"},"maintainers":[{"name":"arboleya","email":"anderson@arboleya.me"}]},"0.3.0":{"name":"ways","version":"0.3.0","author":{"name":"Anderson Arboleya","email":"anderson@arboleya.me"},"description":"Micro router with flow-based navigation mechanism and addapters support","keywords":["router","navigation","flow"],"main":"./lib/ways","scripts":{"test":"make test"},"directories":{"src":"./src"},"repository":{"type":"git","url":"http://github.com/serpentem/ways"},"engines":{"node":">= 0.10"},"dependencies":{"happens":"0.3.x"},"devDependencies":{"chai":"1.8.x","mocha":"1.14.x","mversion":"0.2.x","istanbul":"0.1.x","coveralls":"2.3.x"},"bugs":{"url":"https://github.com/serpentem/ways/issues"},"_id":"ways@0.3.0","dist":{"shasum":"efe28d51a5df9f85b85b94b04fa9259e0635da3e","tarball":"https://registry.npmjs.org/ways/-/ways-0.3.0.tgz","integrity":"sha512-/2s2ERUgUa+XuEFYMAoC0bjhQQA6SfLKVpwik4WaKZni73H+L4R6ia0/NpuZsWjl4M/KGPdwbU0HoWGAv2CkXw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD2oIwqPYyrBlwrH/C8+Q6SQTML5m91jf+h/9iY48EnkQIgbhN1zr7ID2Ht38OT8WYmmNmSSV5ouXIOB5JTqWGV1bo="}]},"_from":".","_npmVersion":"1.2.32","_npmUser":{"name":"arboleya","email":"anderson@arboleya.me"},"maintainers":[{"name":"arboleya","email":"anderson@arboleya.me"}]},"0.3.1":{"name":"ways","version":"0.3.1","author":{"name":"Anderson Arboleya","email":"anderson@arboleya.me"},"description":"Micro router with flow-based navigation mechanism and addapters support","keywords":["router","navigation","flow"],"main":"./lib/ways","scripts":{"test":"make test"},"directories":{"src":"./src"},"repository":{"type":"git","url":"http://github.com/serpentem/ways"},"engines":{"node":">= 0.10"},"dependencies":{"happens":"0.4.x"},"devDependencies":{"chai":"1.8.x","mocha":"1.14.x","mversion":"0.2.x","istanbul":"0.1.x","coveralls":"2.3.x"},"bugs":{"url":"https://github.com/serpentem/ways/issues"},"_id":"ways@0.3.1","dist":{"shasum":"ad639e3a56b42e794df39fe48ac21b4ab7b74fef","tarball":"https://registry.npmjs.org/ways/-/ways-0.3.1.tgz","integrity":"sha512-p/4fee25Qhj5Es8Z972xq8SBKDaS5M7jyCVu9rhyk/k8cVM1fdNpb73fEER2JjcyMxr7j0cq7PlKPAHqBbYpLg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGaWb1vO9gS+7mCc/ZsK2/sDI1k0wPvMgREbr0cQCIgLAiB/3xjc5XdU3m+FkgoPl5MqJpl5ShHGt+K+tLZo+EVQYA=="}]},"_from":".","_npmVersion":"1.2.32","_npmUser":{"name":"arboleya","email":"anderson@arboleya.me"},"maintainers":[{"name":"arboleya","email":"anderson@arboleya.me"}]},"0.3.2":{"name":"ways","version":"0.3.2","author":{"name":"Anderson Arboleya","email":"anderson@arboleya.me"},"description":"Micro router with flow-based navigation mechanism and addapters support","keywords":["router","navigation","flow"],"main":"./lib/ways","scripts":{"test":"make test"},"directories":{"src":"./src"},"repository":{"type":"git","url":"http://github.com/serpentem/ways"},"engines":{"node":">= 0.10"},"dependencies":{"happens":"0.4.x"},"devDependencies":{"chai":"1.8.x","mocha":"1.14.x","mversion":"0.2.x","istanbul":"0.1.x","coveralls":"2.3.x"},"bugs":{"url":"https://github.com/serpentem/ways/issues"},"homepage":"https://github.com/serpentem/ways","_id":"ways@0.3.2","dist":{"shasum":"c52a4346e11a992e819b2c6a8c08671eaed48e8c","tarball":"https://registry.npmjs.org/ways/-/ways-0.3.2.tgz","integrity":"sha512-lqAZQrku23iXueTZkSslrvebl0GkJILaSQZz1zBMABZJHuIQJRX2KND3Z840QGSqatWVVhrdwXj2qJYmJJll7A==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEUk9L5AmuAu9/47ZgjUNLKXZf0UcsekFNYVe3ujmEcxAiBxsGbSWXrr/wCGK1g7GQfeX2htVzq/Vp/ISelGS/XRfg=="}]},"_from":".","_npmVersion":"1.3.14","_npmUser":{"name":"arboleya","email":"anderson@arboleya.me"},"maintainers":[{"name":"arboleya","email":"anderson@arboleya.me"}]},"0.3.3":{"name":"ways","version":"0.3.3","author":{"name":"Anderson Arboleya","email":"anderson@arboleya.me"},"description":"Micro router with flow-based navigation mechanism and addapters support","keywords":["router","navigation","flow"],"main":"./lib/ways","scripts":{"test":"make test"},"directories":{"src":"./src"},"repository":{"type":"git","url":"http://github.com/serpentem/ways"},"engines":{"node":">= 0.10"},"dependencies":{"happens":"0.4.x"},"devDependencies":{"chai":"1.8.x","mocha":"1.14.x","mversion":"0.2.x","istanbul":"0.1.x","coveralls":"2.3.x"},"bugs":{"url":"https://github.com/serpentem/ways/issues"},"homepage":"https://github.com/serpentem/ways","_id":"ways@0.3.3","dist":{"shasum":"b66c83778d27322a486cdad5941cc7ab0547dab0","tarball":"https://registry.npmjs.org/ways/-/ways-0.3.3.tgz","integrity":"sha512-wNequv/DHzuWnABlAVoFs1QWU1Rio0AmVl7xJ736GkiTmHzXRKa6QWpTzxqbrMoV1+6LMBlHOEGkRmRs1xfKwg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQC9/4tndKZGVq879nbk/RIG0LB5WuNHKtcOtsMf+kluuQIgcMZbTDkLPFCDE8ztGgM7vEirrXu8wH+2IO+nqVKu3N4="}]},"_from":".","_npmVersion":"1.3.14","_npmUser":{"name":"arboleya","email":"anderson@arboleya.me"},"maintainers":[{"name":"arboleya","email":"anderson@arboleya.me"}]},"0.3.4":{"name":"ways","version":"0.3.4","author":{"name":"Anderson Arboleya","email":"anderson@arboleya.me"},"description":"Micro router with flow-based navigation mechanism and addapters support","keywords":["router","navigation","flow"],"main":"./lib/ways","scripts":{"test":"make test"},"directories":{"lib":"./lib"},"repository":{"type":"git","url":"http://github.com/serpentem/ways"},"engines":{"node":">= 0.10"},"dependencies":{"happens":"0.4.x"},"devDependencies":{"chai":"1.8.x","mocha":"1.14.x","mversion":"0.2.x","istanbul":"0.1.x","coveralls":"2.3.x"},"bugs":{"url":"https://github.com/serpentem/ways/issues"},"homepage":"https://github.com/serpentem/ways","_id":"ways@0.3.4","dist":{"shasum":"32612c267dea8559b240ec12c49d4705c1f6985c","tarball":"https://registry.npmjs.org/ways/-/ways-0.3.4.tgz","integrity":"sha512-+3E7CU+YSvNg3I4tqR1LCJMUMi7FYZQ98eHq8yM73YM+MCm4/40N49e6SuxqHRZJXOKQq9WpDgIuzuR9e7joxg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDFOMp7dlRiPt2Gm1CNuBsvGDBMoqI1T9LVqS/DwFLLfgIgGwdVHdXCh1dCPo451PsSApGoxjXYmy77YFAorEZ1Kj8="}]},"_from":".","_npmVersion":"1.3.14","_npmUser":{"name":"arboleya","email":"anderson@arboleya.me"},"maintainers":[{"name":"arboleya","email":"anderson@arboleya.me"}]},"0.4.0":{"name":"ways","version":"0.4.0","description":"Fluid router specially designed for complex page transitions and granular UI animations","author":{"name":"Anderson Arboleya","email":"anderson@arboleya.me"},"directories":{"lib":"./lib"},"engines":{"node":">= 0.10"},"keywords":["router","flow","fluid","navigation","chain","transitions","spa"],"main":"./lib/ways","repository":{"type":"git","url":"http://github.com/arboleya/ways"},"scripts":{"test":"make test"},"dependencies":{"happens":"0.6.0","ways-addressbar":"^0.2.1"},"devDependencies":{"chai":"^2.2.0","codeclimate-test-reporter":"0.0.4","coveralls":"^2.11.2","istanbul":"^0.3.13","mocha":"^2.2.4","mversion":"^1.10.0","npm-check":"^3.2.10","spacejam":"^1.2.0"},"gitHead":"e50906ba4a8c345b99887e4739ccf82c5cb74bb4","bugs":{"url":"https://github.com/arboleya/ways/issues"},"homepage":"https://github.com/arboleya/ways","_id":"ways@0.4.0","_shasum":"50213eb277d554ca13c304c137b13df658564cbf","_from":".","_npmVersion":"2.7.4","_nodeVersion":"0.12.2","_npmUser":{"name":"arboleya","email":"anderson@arboleya.me"},"dist":{"shasum":"50213eb277d554ca13c304c137b13df658564cbf","tarball":"https://registry.npmjs.org/ways/-/ways-0.4.0.tgz","integrity":"sha512-E9Eh8sxFcObdsOAK2p0oPacdZr8h7JMljW5Yq+UilHBNjeJCllMbfYCdF+HfmiVtrYpgWeTUXQjgtXD22j1faQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFhvWY1MxZiE1gkXM4RdW1JAwSbqreba7bWpng0GTh8gAiEAuzGQB4jWFlsZeRRklZhxdrrPWnA6mImc2Lp0yAUtPEs="}]},"maintainers":[{"name":"arboleya","email":"anderson@arboleya.me"}]},"0.5.0":{"name":"ways","version":"0.5.0","description":"Fluid router specially designed for complex page transitions and granular UI animations","author":{"name":"Anderson Arboleya","email":"anderson@arboleya.me"},"directories":{"lib":"./lib"},"engines":{"node":">= 0.10"},"keywords":["router","flow","fluid","navigation","chain","transitions","spa"],"main":"./lib/ways","repository":{"type":"git","url":"http://github.com/arboleya/ways"},"scripts":{"test":"make test"},"dependencies":{"happens":"0.6.0","ways-addressbar":"^0.2.1"},"devDependencies":{"chai":"^2.2.0","codeclimate-test-reporter":"0.0.4","coveralls":"^2.11.2","istanbul":"^0.3.13","mocha":"^2.2.4","mversion":"^1.10.0","npm-check":"^3.2.10","spacejam":"^1.2.0"},"gitHead":"01a91066de320aa045a5301b2a905ba5f8f141f4","bugs":{"url":"https://github.com/arboleya/ways/issues"},"homepage":"https://github.com/arboleya/ways","_id":"ways@0.5.0","_shasum":"5619bb549738e15689d0cdf8379d410a85a802c7","_from":".","_npmVersion":"2.7.4","_nodeVersion":"0.12.2","_npmUser":{"name":"arboleya","email":"anderson@arboleya.me"},"dist":{"shasum":"5619bb549738e15689d0cdf8379d410a85a802c7","tarball":"https://registry.npmjs.org/ways/-/ways-0.5.0.tgz","integrity":"sha512-W3inD5SNefHA3h4iT5euBU3PQPRZbbgmYa9ObhwVe9CCmM2wz6TBObqxWLi4AUfLXKDM32ncKkRl/4Rg2KiUvg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCVoNalXS4PrEEcGtaxKQCj4hKRW4xKyZJwFmnfDPpINQIhAKnzx4VggbedGYdQ5c9XOel1V34Cnlpw7BO5uF9ghO14"}]},"maintainers":[{"name":"arboleya","email":"anderson@arboleya.me"}]}},"readme":"[![Build Status](https://travis-ci.org/arboleya/ways.svg)](https://travis-ci.org/arboleya/ways)\n[![Coverage Status](https://coveralls.io/repos/arboleya/ways/badge.svg?branch=master)](https://coveralls.io/r/arboleya/ways?branch=master)\n[![Code Climate](https://codeclimate.com/repos/553a5f77e30ba071310005d5/badges/b23591a0ab4283258afd/gpa.svg)](https://codeclimate.com/repos/553a5f77e30ba071310005d5/feed)\n[![Dependency Status](https://gemnasium.com/arboleya/ways.svg)](https://gemnasium.com/arboleya/ways)\n\n[![Sauce Test Status](https://saucelabs.com/browser-matrix/ways-addressbar.svg?auth=fbb31316b6b3b70a62d6697c4ce14da3)](https://saucelabs.com/u/ways)\n\n# Ways\n\nFluid router specially designed for [complex page transitions](#flow-mode)\nand [granular UI animations](#flow-mode).\n\nBut not only that.\n\n\n  - [Installation](#installation)\n  - [Basics](#basics)\n    - [AddressBar](#addressbar)\n    - [Go](#go)\n    - [Go Silent](#go-silent)\n    - [Pathname](#pathname)\n  - [Flow mode](#flow-mode)\n    - [Activation](#activation)\n    - [Signature changes](#signature-changes)\n    - [Example](#example)\n      - [Step 1](#step-1)\n      - [Step 2](#step-2)\n      - [Step 3](#step-3)\n  - [Events](#events)\n  - [Restricted urls](#restricted-urls)\n\n\n## Installation\n\n````shell\n# node\nnpm install ways # --save, --save-dev\n\n# bower\nbower install ways # --save, --save-dev\n\n# meteor\nmeteor add arboleya:ways # <- Ways is exported with a **capital** W!\n````\n\n## Basics\n\nBasic signature is `ways(pattern, handler)`.\n\n> In **Meteor**, consider `Ways` is exported with a capital `W`.\n\n````javascript\nvar ways = require('ways');\n\n// simple route\nways('/pages', function(req){\n  // req.pattern, req.url, req.params\n});\n\n// named params\nways('/pages/:id', handler);\n\n// splat params\nways('/pages/:id/tags/*tags', handler);\n\n// optional params\nways('/pages/:id?', handler);\nways('/pages/:id?/tags/*tags?', handler);\n\n// match-all\nways('*', handler);\n\n// initialize with current url\nways.go(ways.pathname());\n````\n\n### AddressBar\n\nBy default `Ways` doesn't offers support for `/pushState` and `#hash`, there's\nno browser dependency whatsoever. Therefore you can use it  wherever you want\nto, even on the server. Or keep in the client, but without affecting urls.\n\nHowever, sometimes you'll want to activate addressbar support, like this:\n\n````javascript\n// activate addressbar support\nways.use(ways.addressbar);\n````\n\nAnd you're done.\n\n\n### Go\n\nRedirects app.\n```javascript\n// ways.go(url, [title, [state]]);\nways.go('/pages');\nways.go('/pages', 'Page Title');\nways.go('/pages', 'Page Title', {foo: 'bar'});\n````\n\n### Go Silent\nSame as `ways.go`, but in silent mode, without triggering any route.\n\n```javascript\n// ways.go.silent(url, [title, [state]]);\nways.go.silent('/pages');\nways.go.silent('/pages', 'Page Title');\nways.go.silent('/pages', 'Page Title', {foo: 'bar'});\n````\n> Think about `go() = pushState`, `go.silent() = replaceState`\n\n### Pathname\n\nGets current pathname.\n\n```javascript\n// ways.pathname();\nways.go(ways.pathname());\n````\n \n## Flow mode\n\nConnect your routes altogheter, creating a dependency graph between them.\n\nLets say you have three routes:\n\n````javascript\nways('/a', function (req) { /* ... */ });\nways('/b', function (req) { /* ... */ });\nways('/c', function (req) { /* ... */ });\n````\n\nNow lets assume that `/c` depends on `/b` that depends on `/a`.\n\nSo when we call `/c`, we really want to execute:\n\n  1. First `/a`\n  1. Then `/b`\n  1. And finally `/c`\n\nThat's what flow based mode would do for you.\n\nAnd more:\n\n * Routes' execution occurs asynchronously and sequentially\n * Dependency chain is computed automatically, no more routes' hell\n * Pack your projects with granular UI animations and complex page transitions\n * Forget the `Layout <- View` paradigm, embrace the `View <-> View` reality\n\n> TODO: Maybe explain wtf is `View <-> View`\n\n\n### Activation\n\nThe passed mode tell the order things should run.\n\n```javascript\n// ways.flow(mode);\nways.flow('destroy+run'); // destroy first, run after\nways.flow('run+destroy'); // run before, destroy after\n````\n\nDon't panic, continue reading.\n\n### Signature changes\n\nIn `flow` mode, the routes can be run or destroyed and signature changes a\nlittle. You must pass two handlers instead of one: a `runner` and a `destroyer`.\n\nOptionally, you may also (*most probably*) pass a `dependency`.\n\n\n````javascript\n// ways(pattern, run, destroy, [dependency])\n\nvar ways = require('ways');\n\nways.flow('destroy+run');\n\nfunction run(req, done){\n  console.log('rendering', req);\n  done();\n}\n\nfunction destroy(req, done){\n  console.log('destroying', req);\n  done();\n}\n\nways('/', run, destroy);\nways('/pages/:id', run, destroy, '/'); // [1]\nways('/pages/:id/edit', run, destroy, '/pages/:id'); // [2]\n\n// [1] 'pages/:id' depends on '/'\n// [2] '/pages/:id/edit' depends on '/pages/:id'\n````\n\nBoth handlers (`run` and `destroy`) will receive two params when called:\n\n- `req` - infos about the request\n- `done`- callback to be called when route finishes running or destroying\n\n### Example\n\nLets take a look at a full example:\n\n````javascript\nvar ways = require('ways');\n\nways.flow('destroy+run');\n\nvar running = '+ RUN url=%s, pattern=%s, params='\nvar destroying = '- DESTROY url=%s, pattern=%s, params='\n\nvar run = function(req, done) {\n  console.log(running, req.url, req.pattern, req.params);\n  done();\n};\n\nvar destroy = function(req, done) {\n  console.log(destroying, req.url, req.pattern, req.params);\n  done();\n};\n\nways('/', run, destroy);\nways('/pages', run, destroy, '/');\nways('/pages/:id', run, destroy, '/pages');\nways('/pages/:id/edit', run, destroy, '/pages/:id');\nways('*', run, destroy); // <- this is a catch all\n````\n\nOk, now lets start our navigation:\n\n#### Step 1\n\n````javascript\n// pretend our firt and current url is '/pages/33/edit',\n// we'll use `ways.pathname()` to get it\n\nways.go(ways.pathname());\n````\n\nThis will produce the following output:\n\n````\n+ RUN url='/', pattern='/', params= Object {}\n+ RUN url='/pages', pattern='/pages', params= Object {}\n+ RUN url='/pages/33', pattern='/pages/:id', params= Object {id: \"33\"}\n+ RUN url='/pages/33/edit', pattern='/pages/:id/edit', params= Object {id: \"33\"} \n````\n> At the beggining there's no route to be destroyed, so the dependency chain is\n> computed and every route gets executed, one after another, asynchronously.\n\n#### Step 2\n\n````javascript\nways.go('/pages/22/edit');\n````\n\nThis will produce the following output:\n\n````\n- DESTROY url='/pages/33/edit', pattern='/pages/:id/edit', params= Object {id: \"33\"}\n- DESTROY url='/pages/33', pattern='/pages/:id', params= Object {id: \"33\"}\n+ RUN url='/pages/22', pattern='/pages/:id', params= Object {id: \"22\"}\n+ RUN url='/pages/22/edit', pattern='/pages/:id/edit', params= Object {id: \"22\"}\n````\n\n> Here we have two routes being destroyed before running the new ones, this is\n> computed again based on the dependency chain. In this case, useless routes are\n> `destroyed` before running the new ones, the opposite is achieved by passing\n> the mode `run+destroy`.\n\n#### Step 3\n\n````javascript\nways.go('/any/route/here');\n````\n\nThis will produce the following output:\n\n````\n- DESTROY url='/pages/22/edit', pattern='/pages/:id/edit', params= Object {id: \"22\"}\n- DESTROY url='/pages/22', pattern='/pages/:id', params= Object {id: \"22\"}\n- DESTROY url='/pages', pattern='/pages', params= Object {}\n- DESTROY url='/', pattern='/', params= Object {}\n+ RUN url='/any/thing/here', pattern='*', params= Object {} \n````\n\n> As the route in question here has no dependencies, note that every other route\n> needs to be destroyed before it runs.\n\n\n## Events\n\nThere's only one global event you can listen to.\n\n````javascript\nways.on('url:change', function(url){\n  console.log('current url is', url);\n});\n````\n\n## Restricted urls\n\nA simple way to have restricted urls would be like:\n\n````javascript\nfunction auth(done){\n  // your logic here\n  done(true);\n}\n\nfunction restrict(action) {\n  return function(req, done) {\n    auth(function(authorized) {\n      if(!authorized)\n        ways.go('/login');\n      else\n        action(req, done);\n    });\n  }\n}\n\nways('/pages/secret', restrict(run), destroy)\n````\n\n# License\n\nThe MIT License (MIT)\n\nCopyright (c) 2013 Anderson Arboleya\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\nthe Software, and to permit persons to whom the Software is furnished to do so,\nsubject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\nFOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\nIN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\nCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.","maintainers":[{"name":"arboleya","email":"anderson@arboleya.me"}],"time":{"modified":"2022-06-28T22:16:18.692Z","created":"2013-11-29T03:40:04.276Z","0.2.0":"2013-11-29T03:40:07.996Z","0.2.1":"2013-11-30T16:26:47.631Z","0.2.2":"2013-12-07T02:40:46.527Z","0.2.3":"2013-12-07T03:10:09.058Z","0.3.0":"2013-12-08T20:33:43.727Z","0.3.1":"2013-12-09T02:22:02.141Z","0.3.2":"2013-12-11T20:16:05.785Z","0.3.3":"2013-12-11T20:18:06.913Z","0.3.4":"2014-01-23T14:15:02.091Z","0.4.0":"2015-04-24T18:33:59.209Z","0.5.0":"2015-04-26T00:07:37.292Z"},"author":{"name":"Anderson Arboleya","email":"anderson@arboleya.me"},"repository":{"type":"git","url":"http://github.com/arboleya/ways"},"readmeFilename":"README.md","homepage":"https://github.com/arboleya/ways","keywords":["router","flow","fluid","navigation","chain","transitions","spa"],"bugs":{"url":"https://github.com/arboleya/ways/issues"}}