nginstack

Class: Route

@nginstack/engine/lib/router/Route~ Route

new Route(opt_routeSet)

Representação de uma rota na API de roteamento HTTP do Engine. Uma rota associa um caminho ao método de um controlador que será responsável por processar a requisição.

Parameters:
Name Type Argument Description
opt_routeSet RouteSet <nullable>

Conjunto de rotas onde esta rota foi declarada, caso tenha sido declarada em um. O conjunto de rotas é utilizado para herdar propriedades que não tenham sido explicitamente configuradas na rota.
See:

Extends

  • RouteDef

Members

<static> resolveGlobalParameter

Função que será chamada por esta classe para resolver parâmetros esperados por uma ação que não foram parametrizados no path. Será gerado um erro ao tentar definir uma ação que espere um parâmetro que não esteja definido em path e que não seja resolvido por esta função.

parameterNames :Array.<string>

Array com os nomes dos parâmetros extraídos de #path.

Type:
  • Array.<string>

Methods

<static> parseAction(action)

Interpreta a expressão da ação definida na rota e retorna o nome do método a ser executado no controlador e os parâmetros que devem ser informados.

Parameters:
Name Type Description
action string

Ação definida na rota.
Returns:
Type
Object

<static> testScope(scope, requiredScope)

Verifica se scope satisfaz o escopo requerido por requiredScope.

Parameters:
Name Type Description
scope string | Array.<string>

Escopos de autorização atribuídos a um usuário e que serão testados. Poderá ser informada uma lista de escopos separados por espaço ou um array de identificadores.
requiredScope string | Array.<string>

Escopo que deve ser satisfeito.
Returns:

True se scope satisfizer requiredScope.

Type
boolean

assign(def)

Atribui a esta instância os valores de uma definição de rota.

Parameters:
Name Type Description
def RouteDef | Record.<*, *>

Definição que terá as propriedades copiadas.

testScope(scope)

Verifica se o escopo informado satisfaz o escopo requerido pela rota.

Parameters:
Name Type Description
scope string

Escopo a ser verificado.
Returns:

True se o escopo satisfizer a configuração desta rota.

Type
boolean