OpenVeo server API for plugins

API Docs for: 7.0.0
Show:

RouteExpression

Defined in: lib/grunt/ngDpTask/RouteExpression.js:10
Module: grunt

Summary

An AngularJS ngRoute JavaScript route expression.

AngularJS route expressions uses when:

$routeProvider.when('/path', {
  resolve: {
    definition1: ['Dependency1', function() {}],
    definition2: ['Dependency2', function() {}],
  }
});

Constructor

RouteExpression

Defined in lib/grunt/ngDpTask/RouteExpression.js:10

Syntax

RouteExpression

(
  • expression
)

Summary

Parameters:

  • expression Object

    The route expression as returned by esprima

Methods

getDefinitions

Defined in lib/grunt/ngDpTask/RouteExpression.js:63

Syntax

getDefinitions

() Array

Summary

Gets AngularJS route definitions.

The following definition expressions are supported:

  • All "resolve" property keys

Returns:

Array:

The list of definitions

getDependencies

Defined in lib/grunt/ngDpTask/RouteExpression.js:32

Syntax

getDependencies

() Array

Summary

Gets AngularJS route expression dependencies.

The following dependency expressions are supported:

  • The attribute "controller" of the route
  • All dependencies injected in "resolve" properties

Returns:

Array:

The list of dependencies

isValid

Defined in lib/grunt/ngDpTask/RouteExpression.js:86

Syntax

isValid

() Boolean

Summary

Validates that the expression is a route expression.

An AngularJS route definition expression must have two arguments:

  • The path of the route
  • The route description object

Returns:

Boolean:

true if this is a valid route expression