# ControllerProvider Class

Module
import { ControllerProvider } from "@tsed/common"
Source/packages/common/src/platform/domain/ControllerProvider.ts

# Overview

class ControllerProvider extends Provider<any> {
    router: IPlatformDriver;
    /**
     * The path for the controller
     */
    path: string;
    /**
     * Controllers that depend to this controller.
     * @type {Array}
     * @private
     */

<span class="token keyword">constructor</span><span class="token punctuation">(</span>provide<span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
/**
 *
 * @returns <span class="token punctuation">{</span>Endpoint<span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">}</span>
 */
get <span class="token function">endpoints</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <a href="/api/common/mvc/models/EndpointMetadata.html"><span class="token">EndpointMetadata</span></a><span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span>
/**
 *
 * @returns <span class="token punctuation">{</span><a href="/api/core/interfaces/Type.html"><span class="token">Type</span></a>&lt;<span class="token keyword">any</span>&gt;<span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">}</span>
 */
get <span class="token function">children</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <a href="/api/common/platform/domain/IChildrenController.html"><span class="token">IChildrenController</span></a><span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span>
/**
 *
 * @param children
 */
set <span class="token function">children</span><span class="token punctuation">(</span>children<span class="token punctuation">:</span> <a href="/api/common/platform/domain/IChildrenController.html"><span class="token">IChildrenController</span></a><span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
/**
 *
 * @returns <span class="token punctuation">{</span>IRouterSettings<span class="token punctuation">}</span>
 */
get <span class="token function">routerOptions</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">;</span>
/**
 *
 * @param value
 */
set <span class="token function">routerOptions</span><span class="token punctuation">(</span>value<span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
/**
 *
 * @returns <span class="token punctuation">{</span>ControllerProvider<span class="token punctuation">}</span>
 */
get <span class="token function">parent</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">;</span>
/**
 *
 * @returns <span class="token punctuation">{</span><span class="token keyword">any</span><span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">}</span>
 */
get <span class="token function">middlewares</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <a href="/api/common/mvc/decorators/class/IControllerMiddlewares.html"><span class="token">IControllerMiddlewares</span></a><span class="token punctuation">;</span>
/**
 *
 * @param middlewares
 */
set <span class="token function">middlewares</span><span class="token punctuation">(</span>middlewares<span class="token punctuation">:</span> <a href="/api/common/mvc/decorators/class/IControllerMiddlewares.html"><span class="token">IControllerMiddlewares</span></a><span class="token punctuation">)</span><span class="token punctuation">;</span>
/**
 * Resolve final endpoint url.
 */
<span class="token function">getEndpointUrl</span><span class="token punctuation">(</span>routerPath?<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">;</span>
/**
 *
 */
<span class="token function">hasEndpointUrl</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">boolean</span><span class="token punctuation">;</span>
/**
 *
 * @returns <span class="token punctuation">{</span><span class="token keyword">boolean</span><span class="token punctuation">}</span>
 */
<span class="token function">hasChildren</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">boolean</span><span class="token punctuation">;</span>
/**
 *
 * @returns <span class="token punctuation">{</span><span class="token keyword">boolean</span><span class="token punctuation">}</span>
 */
<span class="token function">hasParent</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">boolean</span><span class="token punctuation">;</span>

}

# Constructor

constructor(provide: any);

Controllers that depend to this controller.

# Members

path: string;

The path for the controller

get endpoints(): EndpointMetadata[];
get children(): IChildrenController[];
set children(children: IChildrenController[]);
get routerOptions(): any;
set routerOptions(value: any);
get parent(): any;
get middlewares(): IControllerMiddlewares;
set middlewares(middlewares: IControllerMiddlewares);
getEndpointUrl(routerPath?: string): string;

Resolve final endpoint url.

hasEndpointUrl(): boolean;
hasChildren(): boolean;
hasParent(): boolean;