import ExecutableRoute from 'devapt-core-services/js/executables/executable_route.js'

public class | source

ExecutableRoute

Extends:

devapt-core-common/dist/js/base/executable~Executable → ExecutableRoute

Direct Subclass:

ExecutableRouteAssets, ExecutableRouteGetResources, ExecutableRouteMiddleware, ExecutableRouteModelCrud

Constructor Summary

Public Constructor
public abstract	constructor() Create a ExecutableRoute instance.

Member Summary

Protected Members
protected	server: object Executable server.
protected	store_config: object Executable settings.

Method Summary

Public Methods
public	execute(arg_data: object): object Execution with contextual informations.
public abstract	get_route_cb(arg_application: TopologyDefineApplication, arg_cfg_route: object, arg_data: object, route: function) Callback for route handling.
public	get_route_redirect_cb(arg_application: TopologyDefineApplication, arg_cfg_route: object, arg_data: object, route: function): * Callback for redirect route handling.
public	prepare(arg_settings: object): nothing Prepare an execution with contextual informations.
public	process_route(arg_server: Server, arg_application: TopologyDefineApplication, arg_cfg_route: object, arg_data: object): Promise Process a route registering.

Public Constructors

public abstract constructor() source

Create a ExecutableRoute instance.

Protected Members

protected server: object source

Executable server.

protected store_config: object source

Executable settings.

Public Methods

public execute(arg_data: object): object source

Execution with contextual informations.

Params:

Name	Type	Attribute	Description
arg_data	object		Application instance.

Return:

object

promise.

public abstract get_route_cb(arg_application: TopologyDefineApplication, arg_cfg_route: object, arg_data: object, route: function) source

Callback for route handling.

Params:

Name	Type	Attribute	Description
arg_application	TopologyDefineApplication		Application instance.
arg_cfg_route	object		plain object route configuration.
arg_data	object		plain object contextual datas.
route	function		handler.

public get_route_redirect_cb(arg_application: TopologyDefineApplication, arg_cfg_route: object, arg_data: object, route: function): * source

Callback for redirect route handling.

Params:

Name	Type	Attribute	Description
arg_application	TopologyDefineApplication		Application instance.
arg_cfg_route	object		plain object route configuration.
arg_data	object		plain object contextual datas.
route	function		handler.

Return:

public prepare(arg_settings: object): nothing source

Prepare an execution with contextual informations.

Params:

Name	Type	Attribute	Description
arg_settings	object		execution settings.

Return:

nothing

public process_route(arg_server: Server, arg_application: TopologyDefineApplication, arg_cfg_route: object, arg_data: object): Promise source

Process a route registering.

Params:

Name	Type	Attribute	Description
arg_server	Server		Server instance.
arg_application	TopologyDefineApplication		Application instance.
arg_cfg_route	object		plain object route configuration.
arg_data	object		plain object contextual datas.

Return:

Promise

Promise(boolean) with (true:success, false: failure).