@moostjs/event-http 0.5.21 → 0.5.23

package/dist/index.d.ts

@@ -1,8 +1,8 @@
+/// <reference types="node" />
 import { THook } from '@wooksjs/event-core';
 import { TCookieAttributes as TCookieAttributes$1, useSetCookies, WooksHttp, TWooksHttpOptions } from '@wooksjs/event-http';
 export { HttpError, TCacheControl, TCookieAttributesInput, TSetCookieData, useHttpContext } from '@wooksjs/event-http';
-import { TInterceptorFn, TMoostAdapter, Moost, TMoostAdapterOptions } from 'moost';
-import * as _prostojs_logger from '@prostojs/logger';
+import { TInterceptorFn, TMoostAdapter, Moost, TConsoleBase, TMoostAdapterOptions } from 'moost';
 import * as _prostojs_infact from '@prostojs/infact';
 import * as http from 'http';
 import { TProstoRouterPathBuilder } from '@prostojs/router';
@@ -16,119 +16,26 @@ declare const Put: (path?: string) => MethodDecorator;
 declare const Delete: (path?: string) => MethodDecorator;
 declare const Patch: (path?: string) => MethodDecorator;
 
-/**
- * Hook to the Response Status
- * @decorator
- * @paramType TStatusHook
- */
 declare const StatusHook: () => ParameterDecorator & PropertyDecorator;
-/**
- * Hook to the Response Header
- * @decorator
- * @param name - header name
- * @paramType THeaderHook
- */
 declare const HeaderHook: (name: string) => ParameterDecorator & PropertyDecorator;
-/**
- * Hook to the Response Cookie
- * @decorator
- * @param name - cookie name
- * @paramType TCookieHook
- */
 declare const CookieHook: (name: string) => ParameterDecorator & PropertyDecorator;
-/**
- * Hook to the Response Cookie Attributes
- * @decorator
- * @param name - cookie name
- * @paramType TCookieAttributes
- */
 declare const CookieAttrsHook: (name: string) => ParameterDecorator & PropertyDecorator;
-/**
- * Parse Authorisation Header
- * @decorator
- * @param name - define what to take from the Auth header
- * @paramType string
- */
 declare function Authorization(name: 'username' | 'password' | 'bearer' | 'raw' | 'type'): ParameterDecorator & PropertyDecorator;
-/**
- * Get Request Header Value
- * @decorator
- * @param name - header name
- * @paramType string
- */
 declare function Header(name: string): ParameterDecorator & PropertyDecorator;
-/**
- * Get Request Cookie Value
- * @decorator
- * @param name - cookie name
- * @paramType string
- */
 declare function Cookie(name: string): ParameterDecorator & PropertyDecorator;
-/**
- * Get Query Item value or the whole parsed Query as an object
- * @decorator
- * @param name - query item name (optional)
- * @paramType string | object
- */
 declare function Query(name?: string): ParameterDecorator;
-/**
- * Get Requested URL
- * @decorator
- * @paramType string
- */
 declare function Url(): ParameterDecorator & PropertyDecorator;
-/**
- * Get Requested HTTP Method
- * @decorator
- * @paramType string
- */
 declare function Method(): ParameterDecorator & PropertyDecorator;
-/**
- * Get Raw Request Instance
- * @decorator
- * @paramType IncomingMessage
- */
 declare function Req(): ParameterDecorator & PropertyDecorator;
-/**
- * Get Raw Response Instance
- * @decorator
- * @param opts (optional) { passthrough: boolean }
- * @paramType ServerResponse
- */
 declare function Res(opts?: {
     passthrough: boolean;
 }): ParameterDecorator & PropertyDecorator;
-/**
- * Get Request Unique Identificator (UUID)
- * @decorator
- * @paramType string
- */
 declare function ReqId(): ParameterDecorator & PropertyDecorator;
-/**
- * Get Request IP Address
- * @decorator
- * @paramType string
- */
 declare function Ip(opts?: {
     trustProxy: boolean;
 }): ParameterDecorator & PropertyDecorator;
-/**
- * Get Request IP Address list
- * @decorator
- * @paramType string[]
- */
 declare function IpList(): ParameterDecorator & PropertyDecorator;
-/**
- * Get Parsed Request Body
- * @decorator
- * @paramType object | string | unknown
- */
 declare function Body(): MethodDecorator & ClassDecorator & ParameterDecorator & PropertyDecorator;
-/**
- * Get Raw Request Body Buffer
- * @decorator
- * @paramType Promise<Buffer>
- */
 declare function RawBody(): ParameterDecorator & PropertyDecorator;
 type TStatusHook = THook<number>;
 type THeaderHook = THook;
@@ -140,120 +47,18 @@ declare const setHeaderInterceptor: (name: string, value: string, opts?: {
     status?: number;
     when?: 'always' | 'error' | 'ok';
 }) => TInterceptorFn;
-/**
- * Set Header for Request Handler
- *
- * ```ts
- * import { Get, SetHeader } from '@moostjs/event-http';
- * import { Controller } from 'moost';
- *
- * @Controller()
- * export class ExampleController {
- *   @Get('test')
- *   // setting header for request handler
- *   @SetHeader('x-server', 'my-server')
- *   testHandler() {
- *     return '...'
- *   }
- * }
- * ```
- *
- * ```ts
- * import { Get, SetHeader } from '@moostjs/event-http';
- * import { Controller } from 'moost';
- *
- * @Controller()
- * export class ExampleController {
- *   @Get('test')
- *   // setting header only if status = 400
- *   @SetHeader('content-type', 'text/plain', { status: 400 })
- *   testHandler() {
- *     return '...'
- *   }
- * }
- * ```
- *
- * @param name  name of header
- * @param value value for header
- * @param options options { status?: number, force?: boolean }
- */
 declare function SetHeader(...args: Parameters<typeof setHeaderInterceptor>): ClassDecorator & MethodDecorator;
 declare const setCookieInterceptor: (...args: Parameters<ReturnType<typeof useSetCookies>['setCookie']>) => TInterceptorFn;
-/**
- * Set Cookie for Request Handler
- * ```ts
- * import { Get, SetCookie } from '@moostjs/event-http';
- * import { Controller } from 'moost';
- *
- * @Controller()
- * export class ExampleController {
- *   @Get('test')
- *   // setting 'my-cookie' = 'value' with maxAge of 10 minutes
- *   @SetCookie('my-cookie', 'value', { maxAge: '10m' })
- *   testHandler() {
- *     return '...'
- *   }
- * }
- * ```
- *
- * @param name  name of cookie
- * @param value value for cookie
- * @param attrs cookie attributes
- */
 declare function SetCookie(...args: Parameters<typeof setCookieInterceptor>): ClassDecorator & MethodDecorator;
 declare const setStatusInterceptor: (code: number, opts?: {
     force?: boolean;
 }) => TInterceptorFn;
-/**
- * Set Response Status for Request Handler
- *
- * ```ts
- * import { Get, SetStatus } from '@moostjs/event-http';
- * import { Controller } from 'moost';
- *
- * @Controller()
- * export class ExampleController {
- *   @Get('test')
- *   @SetStatus(201)
- *   testHandler() {
- *     return '...'
- *   }
- * }
- * ```
- * @param code number
- * @param opts optional { force?: boolean }
- */
 declare function SetStatus(...args: Parameters<typeof setStatusInterceptor>): ClassDecorator & MethodDecorator;
 
 interface THttpHandlerMeta {
     method: string;
     path: string;
 }
-/**
- * ## Moost HTTP Adapter
- *
- * Moost Adapter for HTTP events
- *
- * ```ts
- * │  // HTTP server example
- * │  import { MoostHttp, Get } from '@moostjs/event-http'
- * │  import { Moost, Param } from 'moost'
- * │
- * │  class MyServer extends Moost {
- * │      @Get('test/:name')
- * │      test(@Param('name') name: string) {
- * │          return { message: `Hello ${name}!` }
- * │      }
- * │  }
- * │
- * │  const app = new MyServer()
- * │  const http = new MoostHttp()
- * │  app.adapter(http).listen(3000, () => {
- * │      app.getLogger('MyApp').log('Up on port 3000')
- * │  })
- * │  app.init()
- * ```
- */
 declare class MoostHttp implements TMoostAdapter<THttpHandlerMeta> {
     readonly name = "http";
     protected httpApp: WooksHttp;
@@ -280,7 +85,7 @@ declare class MoostHttp implements TMoostAdapter<THttpHandlerMeta> {
     protected moost?: Moost;
     onInit(moost: Moost): void;
     getProvideRegistry(): _prostojs_infact.TProvideRegistry;
-    getLogger(): _prostojs_logger.TConsoleBase;
+    getLogger(): TConsoleBase;
     bindHandler<T extends object = object>(opts: TMoostAdapterOptions<THttpHandlerMeta, T>): void;
 }