feat(common): Add documentation for public API

nestjs · Aug 26, 2019 · 2ee5a99 · 2ee5a99
1 parent 9c1ec0d
commit 2ee5a99
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/packages/common/decorators/core/controller.decorator.ts b/packages/common/decorators/core/controller.decorator.ts
@@ -17,6 +17,9 @@ export interface ControllerOptions extends ScopeOptions {
   path?: string;
 }
 
+export function Controller();
+export function Controller(prefix: string);
+export function Controller(options: ControllerOptions);
 /**
  * Decorator that marks a class as a Nest controller that can receive inbound
  * requests and produce responses.

diff --git a/packages/common/decorators/core/inject.decorator.ts b/packages/common/decorators/core/inject.decorator.ts
@@ -33,7 +33,6 @@ import { isFunction, isUndefined } from '../../utils/shared.utils';
  *
  * @publicApi
  */
-
 export function Inject<T = any>(token?: T) {
   return (target: Object, key: string | symbol, index?: number) => {
     token = token || Reflect.getMetadata('design:type', target, key);

diff --git a/packages/common/decorators/http/route-params.decorator.ts b/packages/common/decorators/http/route-params.decorator.ts
@@ -153,7 +153,6 @@ export const UploadedFile: (
 export const UploadedFiles: () => ParameterDecorator = createRouteParamDecorator(
   RouteParamtypes.FILES,
 );
-
 /**
  * Route handler parameter decorator. Extracts the `headers`
  * property from the `req` object and populates the decorated