@eggjs/controller-decorator 4.0.0-beta.35 → 4.0.0-beta.36

package/dist/decorator/http/HTTPParam.d.ts

@@ -1,173 +1,159 @@
-import type { HTTPParamParams, HTTPQueriesParams, HTTPQueryParams } from '@eggjs/tegg-types';
-import { InjectContext } from '../Context.ts';
+import { InjectContext } from "../Context.js";
+import { HTTPParamParams, HTTPQueriesParams, HTTPQueryParams } from "@eggjs/tegg-types";
+
+//#region src/decorator/http/HTTPParam.d.ts
+
 /**
- * Inject the request body.
- *
- * @example
- * ```typescript
- * import { HTTPController, HTTPMethod, HTTPMethodEnum, HTTPBody } from 'egg';
- *
- * @HTTPController()
- * export class FooController {
- *   @HTTPMethod({
- *     path: '/foo',
- *     method: HTTPMethodEnum.GET,
- *   })
- *   // POST /foo -H 'Content-Type: application/json' -d '{"foo": "bar"}'
- *   // body = { "foo": "bar" }
- *   async bar(@HTTPBody() body: any): Promise<void> {
- *     console.log(body);
- *   }
- * }
- * ```
- */
-export declare function HTTPBody(): (target: any, propertyKey: PropertyKey, parameterIndex: number) => void;
+* Inject the request body.
+*
+* @example
+* ```typescript
+* import { HTTPController, HTTPMethod, HTTPMethodEnum, HTTPBody } from 'egg';
+*
+* @HTTPController()
+* export class FooController {
+*   @HTTPMethod({
+*     path: '/foo',
+*     method: HTTPMethodEnum.GET,
+*   })
+*   // POST /foo -H 'Content-Type: application/json' -d '{"foo": "bar"}'
+*   // body = { "foo": "bar" }
+*   async bar(@HTTPBody() body: any): Promise<void> {
+*     console.log(body);
+*   }
+* }
+* ```
+*/
+declare function HTTPBody(): (target: any, propertyKey: PropertyKey, parameterIndex: number) => void;
 /**
- * Inject the request headers.
- *
- * @example
- * ```typescript
- * import { HTTPController, HTTPMethod, HTTPMethodEnum, HTTPHeaders, type IncomingHttpHeaders } from 'egg';
- *
- * @HTTPController()
- * export class FooController {
- *   @HTTPMethod({
- *     path: '/foo',
- *     method: HTTPMethodEnum.GET,
- *   })
- *   // GET /foo -H 'X-Custom: custom'
- *   // headers['x-custom'] = 'custom'
- *   async bar(@HTTPHeaders() headers: IncomingHttpHeaders): Promise<void> {
- *     console.log(headers);
- *   }
- * }
- * ```
- */
-export declare function HTTPHeaders(): (target: any, propertyKey: PropertyKey, parameterIndex: number) => void;
+* Inject the request headers.
+*
+* @example
+* ```typescript
+* import { HTTPController, HTTPMethod, HTTPMethodEnum, HTTPHeaders, type IncomingHttpHeaders } from 'egg';
+*
+* @HTTPController()
+* export class FooController {
+*   @HTTPMethod({
+*     path: '/foo',
+*     method: HTTPMethodEnum.GET,
+*   })
+*   // GET /foo -H 'X-Custom: custom'
+*   // headers['x-custom'] = 'custom'
+*   async bar(@HTTPHeaders() headers: IncomingHttpHeaders): Promise<void> {
+*     console.log(headers);
+*   }
+* }
+* ```
+*/
+declare function HTTPHeaders(): (target: any, propertyKey: PropertyKey, parameterIndex: number) => void;
 /**
- * Inject the request query string, the value is string type.
- *
- * @example
- * ```typescript
- * import { HTTPController, HTTPMethod, HTTPMethodEnum, HTTPQuery } from 'egg';
- *
- * @HTTPController()
- * export class FooController {
- *   @HTTPMethod({
- *     path: '/foo',
- *     method: HTTPMethodEnum.GET,
- *   })
- *   // GET /foo?user=asd
- *   // user = 'asd'
- *   async bar(@HTTPQuery() user?: string): Promise<void> {
- *     console.log(user);
- *   }
- * }
- * ```
- */
-export declare function HTTPQuery(param?: HTTPQueryParams): (target: any, propertyKey: PropertyKey, parameterIndex: number) => void;
+* Inject the request query string, the value is string type.
+*
+* @example
+* ```typescript
+* import { HTTPController, HTTPMethod, HTTPMethodEnum, HTTPQuery } from 'egg';
+*
+* @HTTPController()
+* export class FooController {
+*   @HTTPMethod({
+*     path: '/foo',
+*     method: HTTPMethodEnum.GET,
+*   })
+*   // GET /foo?user=asd
+*   // user = 'asd'
+*   async bar(@HTTPQuery() user?: string): Promise<void> {
+*     console.log(user);
+*   }
+* }
+* ```
+*/
+declare function HTTPQuery(param?: HTTPQueryParams): (target: any, propertyKey: PropertyKey, parameterIndex: number) => void;
 /**
- * Inject the request query strings, all value are Array type.
- *
- * @example
- * ```typescript
- * import { HTTPController, HTTPMethod, HTTPMethodEnum, HTTPQueries } from 'egg';
- *
- * @HTTPController()
- * export class FooController {
- *   @HTTPMethod({
- *     path: '/foo',
- *     method: HTTPMethodEnum.GET,
- *   })
- *   // GET /foo?user=asd&user=fgh
- *   // user = ['asd', 'fgh']
- *   async bar(@HTTPQueries({ name: 'user' }) users?: string[]): Promise<void> {
- *     console.log(users);
- *   }
- * }
- * ```
- */
-export declare function HTTPQueries(param?: HTTPQueriesParams): (target: any, propertyKey: PropertyKey, parameterIndex: number) => void;
+* Inject the request query strings, all value are Array type.
+*
+* @example
+* ```typescript
+* import { HTTPController, HTTPMethod, HTTPMethodEnum, HTTPQueries } from 'egg';
+*
+* @HTTPController()
+* export class FooController {
+*   @HTTPMethod({
+*     path: '/foo',
+*     method: HTTPMethodEnum.GET,
+*   })
+*   // GET /foo?user=asd&user=fgh
+*   // user = ['asd', 'fgh']
+*   async bar(@HTTPQueries({ name: 'user' }) users?: string[]): Promise<void> {
+*     console.log(users);
+*   }
+* }
+* ```
+*/
+declare function HTTPQueries(param?: HTTPQueriesParams): (target: any, propertyKey: PropertyKey, parameterIndex: number) => void;
 /**
- * Inject the request path parameter, the value is string type.
- *
- * @example
- * ```typescript
- * import { HTTPController, HTTPMethod, HTTPMethodEnum, HTTPParam } from 'egg';
- *
- * @HTTPController()
- * export class FooController {
- *   @HTTPMethod({
- *     path: '/foo/:id',
- *     method: HTTPMethodEnum.GET,
- *   })
- *   // GET /foo/123
- *   // id = '123'
- *   async bar(@HTTPParam() id: string): Promise<void> {
- *     console.log(id);
- *   }
- * }
- * ```
- */
-export declare function HTTPParam(param?: HTTPParamParams): (target: any, propertyKey: PropertyKey, parameterIndex: number) => void;
+* Inject the request path parameter, the value is string type.
+*
+* @example
+* ```typescript
+* import { HTTPController, HTTPMethod, HTTPMethodEnum, HTTPParam } from 'egg';
+*
+* @HTTPController()
+* export class FooController {
+*   @HTTPMethod({
+*     path: '/foo/:id',
+*     method: HTTPMethodEnum.GET,
+*   })
+*   // GET /foo/123
+*   // id = '123'
+*   async bar(@HTTPParam() id: string): Promise<void> {
+*     console.log(id);
+*   }
+* }
+* ```
+*/
+declare function HTTPParam(param?: HTTPParamParams): (target: any, propertyKey: PropertyKey, parameterIndex: number) => void;
 /**
- * Inject the request object.
- *
- * @example
- * ```typescript
- * import { HTTPController, HTTPMethod, HTTPMethodEnum, HTTPRequest } from 'egg';
- *
- * @HTTPController()
- * export class FooController {
- *   @HTTPMethod({
- *     path: '/foo',
- *     method: HTTPMethodEnum.GET,
- *   })
- *   async bar(@HTTPRequest() request: Request): Promise<void> {
- *     console.log(request);
- *   }
- * }
- * ```
- */
-export declare function HTTPRequest(): (target: any, propertyKey: PropertyKey, parameterIndex: number) => void;
+* Inject the request object.
+*
+* @example
+* ```typescript
+* import { HTTPController, HTTPMethod, HTTPMethodEnum, HTTPRequest } from 'egg';
+*
+* @HTTPController()
+* export class FooController {
+*   @HTTPMethod({
+*     path: '/foo',
+*     method: HTTPMethodEnum.GET,
+*   })
+*   async bar(@HTTPRequest() request: Request): Promise<void> {
+*     console.log(request);
+*   }
+* }
+* ```
+*/
+declare function HTTPRequest(): (target: any, propertyKey: PropertyKey, parameterIndex: number) => void;
 /**
- * Inject the request cookies.
- *
- * @example
- * ```typescript
- * import { HTTPController, HTTPMethod, HTTPMethodEnum, HTTPCookies, type Cookies } from 'egg';
- *
- * @HTTPController()
- * export class FooController {
- *   @HTTPMethod({
- *     path: '/foo',
- *     method: HTTPMethodEnum.GET,
- *   })
- *   // GET /foo -H 'Cookie: foo=bar; bar=baz'
- *   // cookies = cookies
- *   async bar(@HTTPCookies() cookies: Cookies): Promise<void> {
- *     console.log(cookies);
- *   }
- * }
- * ```
- */
-export declare function HTTPCookies(): (target: any, propertyKey: PropertyKey, parameterIndex: number) => void;
-export { 
-/**
- * @example
- *
- * ```typescript
- * import { HTTPController, HTTPMethod, HTTPMethodEnum, HTTPContext, type Context } from 'egg';
- *
- * @HTTPController()
- * export class FooController {
- *   @HTTPMethod({
- *     path: '/foo',
- *     method: HTTPMethodEnum.GET,
- *   })
- * async bar(@HTTPContext() ctx: Context): Promise<void> {
- *   console.log(ctx);
- * }
- * ```
- */
-InjectContext as HTTPContext, };
+* Inject the request cookies.
+*
+* @example
+* ```typescript
+* import { HTTPController, HTTPMethod, HTTPMethodEnum, HTTPCookies, type Cookies } from 'egg';
+*
+* @HTTPController()
+* export class FooController {
+*   @HTTPMethod({
+*     path: '/foo',
+*     method: HTTPMethodEnum.GET,
+*   })
+*   // GET /foo -H 'Cookie: foo=bar; bar=baz'
+*   // cookies = cookies
+*   async bar(@HTTPCookies() cookies: Cookies): Promise<void> {
+*     console.log(cookies);
+*   }
+* }
+* ```
+*/
+declare function HTTPCookies(): (target: any, propertyKey: PropertyKey, parameterIndex: number) => void;
+//#endregion
+export { HTTPBody, HTTPCookies, HTTPHeaders, HTTPParam, HTTPQueries, HTTPQuery, HTTPRequest };