Skip to content

Commit fd16cc7

Browse files
committed
docs(stateFilters): adds docs for state filters
1 parent 388f8f8 commit fd16cc7

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

src/stateFilters.js

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,28 @@
1+
/**
2+
* @ngdoc filter
3+
* @name ui.router.state.filter:isState
4+
*
5+
* @requires ui.router.state.$state
6+
*
7+
* @description
8+
* Translates to {@link ui.router.state.$state#is $state.is("stateName")}.
9+
*/
110
$IsStateFilter.$inject = ['$state'];
211
function $IsStateFilter($state) {
312
return function(state) {
413
return $state.is(state);
514
};
615
}
716

17+
/**
18+
* @ngdoc filter
19+
* @name ui.router.state.filter:includeByState
20+
*
21+
* @requires ui.router.state.$state
22+
*
23+
* @description
24+
* Translates to {@link ui.router.state.$state#includes $state.includes()}.
25+
*/
826
$IncludedByStateFilter.$inject = ['$state'];
927
function $IncludedByStateFilter($state) {
1028
return function(state) {

0 commit comments

Comments
 (0)