can-route/doc/currentRule.md

Observable front-end application routing for CanJS.

@function can-route.currentRule currentRule
@parent can-route.static
@description A compute representing the currently matched routing rule route.

@signature `route.currentRule()`
  Use `route.currentRule()` to find the current route rule.

  ```js
  import {route} from "can";

  route.register( "{type}" );
  route.register( "{type}/{subtype}" );
  route.start();

  route.data.type = "foo";
  setTimeout(() => {
    console.log( route.currentRule() ); //-> "{type}"
    
    route.data.subtype = "bar";
  }, 100);

  setTimeout(() => {
    console.log( route.currentRule() ); //-> "{type}/{subtype}"
  }, 200);
  ```
  @codepen

  @return {String} The currently matched [can-route.register registered] routing rule.