@spinajs/http 2.0.179 → 2.0.181

package/lib/mjs/decorators.d.ts

@@ -1,184 +1,184 @@
-import { Constructor } from '@spinajs/di';
-import { ParameterType, IControllerDescriptor, BasePolicy, RouteMiddleware, IRoute, IUploadOptions, UuidVersion, IFormOptions } from './interfaces.js';
-import { ArgHydrator } from './route-args/ArgHydrator.js';
-export declare const CONTROLLED_DESCRIPTOR_SYMBOL: unique symbol;
-export declare function Route(callback: (controller: IControllerDescriptor, route: IRoute, target: any, propertyKey?: string, indexOrDescriptor?: number | PropertyDescriptor) => void): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-/**
- * Ugly hack to specify type for route args. Mostly used to define type of array, becouse typescript does not
- * have information about this.
- */
-export declare function Type(type: any): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-export declare function Parameter(type: ParameterType | string, schema?: any, options?: any): (_: IControllerDescriptor, route: IRoute, target: any, propertyKey: string, index: number) => void;
-/**
- * Tells controller how to fill up incoming parameters in controller actions
- *
- * @param hydrator - hydrator class that will fill up incoming argument
- * @param options - additional options passed to hydrator
- */
-export declare function Hydrator(hydrator: Constructor<ArgHydrator>, ...options: any[]): (target: any) => void;
-/**
- *
- * @param policy - policy to set. Could be type or path in configuration to with policy to inject ( eg. metrics.auth.policy )
- * @param options
- * @returns
- */
-export declare function Policy(policy: Constructor<BasePolicy> | string, ...options: any[]): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-export declare function Middleware(policy: Constructor<RouteMiddleware>, ...options: any[]): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-export declare function BasePath(path: string): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-export declare function FromDI(): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-/**
- * Gets whole body field
- * @returns body field of request
- */
-export declare function BodyField(): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-export declare function AcceptType(): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-/**
- * Gets all headers field ot type express.IncommingHttpHeaders
- * @returns headers field of request
- */
-export declare function HeadersField(): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-/**
- * Get whole query field from request.
- *
- * @returns whole request field of request
- */
-export declare function QueryField(): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-/**
- * Get whole params field from request.
- * @returns whole request field of request
- */
-export declare function ParamField(): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-/**
- * Route parameter taken from query string eg. route?id=1
- *
- * @param schema - parameter json schema for optional validation
- */
-export declare function Query(schema?: any): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-/**
- * Route parameter taken from message body (POST)
- *
- * @param schema - parameter json schema for optional validation
- */
-export declare function Body(): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-/**
- * Route parameter taken from url parameters eg. route/:id
- *
- * @param schema - parameter json schema for optional validation
- */
-export declare function Param(schema?: any): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-/**
- * Gets parameter from request header. If not keyname is provided
- * variable name is used as header key name
- *
- * @param keyName - header key name ( optional )
- * @param schema - schema for validation ( optional )
- * @returns
- */
-export declare function Header(keyName?: string, schema?: any): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-/**
- *
- * Parameter as file
- *
- * @param options - upload options
- */
-export declare function File(options?: IUploadOptions): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-/**
- * Data taken from cvs file that is uploaded. Actions receives parsed data
- *
- * @param options - upload options
- * @param cvsParseOptions - cvs parser options
- * @param schema - optional schema for data validation
- */
-export declare function CsvFile(options?: IUploadOptions, cvsParseOptions?: any): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-/**
- * Data taken from cvs file that is uploaded. Actions receives parsed data
- *
- * @param options - upload options
- * @param schema - optional schema for data validation
- */
-export declare function JsonFile(options?: IUploadOptions): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-/**
- *
- * Parameter taken from form data (multipart-form)
- *
- * @param options - upload options
- */
-export declare function Form(options?: IFormOptions): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-/**
- *
- * Parameter taken from form data (multipart-form)
- *
- * @param options - upload options
- */
-export declare function FormField(schema?: any, options?: IFormOptions): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-/**
- *
- * Shortcut for parameter as autoincrement primary key ( number greater than 0)
- *
- */
-export declare function PKey(type?: ParameterType): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-/**
- *
- * Shortcut for parameter as uuid primary key ( string with 32 length )
- *
- */
-export declare function Uuid(type?: ParameterType, version?: UuidVersion): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-/**
- *
- *  Express request
- *
- */
-export declare function Req(): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-/**
- *
- *  Express res
- *
- */
-export declare function Res(): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-/**
- *
- * Parameter taken from model
- *
- * @param options - upload options
- */
-export declare function Model(model: Constructor<any>): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-/**
- *
- * Parameter taken from coockie
- *
- * @param options - upload options
- */
-export declare function Cookie(): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-/**
- * Creates HEAD http request method
- * @param path - url path to method eg. /foo/bar/:id
- */
-export declare function Head(path?: string, schema?: any): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-/**
- * Creates PATCH http request method
- * @param path - url path to method eg. /foo/bar/:id
- */
-export declare function Patch(path?: string, schema?: any): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-/**
- * Creates DELETE http request method
- * @param path - url path to method eg. /foo/bar/:id
- * @param routeName - route name visible in api. If undefined, method name is taken
- */
-export declare function Del(path?: string, schema?: any): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-/**
- * Creates PUT http request method
- * @param path - url path to method eg. /foo/bar/:id
- */
-export declare function Put(path?: string, schema?: any): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-/**
- * Creates GET http request method
- * @param path - url path to method eg. /foo/bar/:id
- */
-export declare function Get(path?: string, schema?: any): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
-/**
- * Creates POST http request method
- *
- * @param path - url path to method eg. /foo/bar
- */
-export declare function Post(path?: string, schema?: any): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+import { Constructor } from '@spinajs/di';
+import { ParameterType, IControllerDescriptor, BasePolicy, RouteMiddleware, IRoute, IUploadOptions, UuidVersion, IFormOptions } from './interfaces.js';
+import { ArgHydrator } from './route-args/ArgHydrator.js';
+export declare const CONTROLLED_DESCRIPTOR_SYMBOL: unique symbol;
+export declare function Route(callback: (controller: IControllerDescriptor, route: IRoute, target: any, propertyKey?: string, indexOrDescriptor?: number | PropertyDescriptor) => void): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+/**
+ * Ugly hack to specify type for route args. Mostly used to define type of array, becouse typescript does not
+ * have information about this.
+ */
+export declare function Type(type: any): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+export declare function Parameter(type: ParameterType | string, schema?: any, options?: any): (_: IControllerDescriptor, route: IRoute, target: any, propertyKey: string, index: number) => void;
+/**
+ * Tells controller how to fill up incoming parameters in controller actions
+ *
+ * @param hydrator - hydrator class that will fill up incoming argument
+ * @param options - additional options passed to hydrator
+ */
+export declare function Hydrator(hydrator: Constructor<ArgHydrator>, ...options: any[]): (target: any) => void;
+/**
+ *
+ * @param policy - policy to set. Could be type or path in configuration to with policy to inject ( eg. metrics.auth.policy )
+ * @param options
+ * @returns
+ */
+export declare function Policy(policy: Constructor<BasePolicy> | string, ...options: any[]): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+export declare function Middleware(policy: Constructor<RouteMiddleware>, ...options: any[]): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+export declare function BasePath(path: string): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+export declare function FromDI(): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+/**
+ * Gets whole body field
+ * @returns body field of request
+ */
+export declare function BodyField(): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+export declare function AcceptType(): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+/**
+ * Gets all headers field ot type express.IncommingHttpHeaders
+ * @returns headers field of request
+ */
+export declare function HeadersField(): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+/**
+ * Get whole query field from request.
+ *
+ * @returns whole request field of request
+ */
+export declare function QueryField(): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+/**
+ * Get whole params field from request.
+ * @returns whole request field of request
+ */
+export declare function ParamField(): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+/**
+ * Route parameter taken from query string eg. route?id=1
+ *
+ * @param schema - parameter json schema for optional validation
+ */
+export declare function Query(schema?: any): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+/**
+ * Route parameter taken from message body (POST)
+ *
+ * @param schema - parameter json schema for optional validation
+ */
+export declare function Body(): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+/**
+ * Route parameter taken from url parameters eg. route/:id
+ *
+ * @param schema - parameter json schema for optional validation
+ */
+export declare function Param(schema?: any): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+/**
+ * Gets parameter from request header. If not keyname is provided
+ * variable name is used as header key name
+ *
+ * @param keyName - header key name ( optional )
+ * @param schema - schema for validation ( optional )
+ * @returns
+ */
+export declare function Header(keyName?: string, schema?: any): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+/**
+ *
+ * Parameter as file
+ *
+ * @param options - upload options
+ */
+export declare function File(options?: IUploadOptions): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+/**
+ * Data taken from cvs file that is uploaded. Actions receives parsed data
+ *
+ * @param options - upload options
+ * @param cvsParseOptions - cvs parser options
+ * @param schema - optional schema for data validation
+ */
+export declare function CsvFile(options?: IUploadOptions, cvsParseOptions?: any): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+/**
+ * Data taken from cvs file that is uploaded. Actions receives parsed data
+ *
+ * @param options - upload options
+ * @param schema - optional schema for data validation
+ */
+export declare function JsonFile(options?: IUploadOptions): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+/**
+ *
+ * Parameter taken from form data (multipart-form)
+ *
+ * @param options - upload options
+ */
+export declare function Form(options?: IFormOptions): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+/**
+ *
+ * Parameter taken from form data (multipart-form)
+ *
+ * @param options - upload options
+ */
+export declare function FormField(schema?: any, options?: IFormOptions): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+/**
+ *
+ * Shortcut for parameter as autoincrement primary key ( number greater than 0)
+ *
+ */
+export declare function PKey(type?: ParameterType): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+/**
+ *
+ * Shortcut for parameter as uuid primary key ( string with 32 length )
+ *
+ */
+export declare function Uuid(type?: ParameterType, version?: UuidVersion): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+/**
+ *
+ *  Express request
+ *
+ */
+export declare function Req(): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+/**
+ *
+ *  Express res
+ *
+ */
+export declare function Res(): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+/**
+ *
+ * Parameter taken from model
+ *
+ * @param options - upload options
+ */
+export declare function Model(model: Constructor<any>): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+/**
+ *
+ * Parameter taken from coockie
+ *
+ * @param options - upload options
+ */
+export declare function Cookie(): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+/**
+ * Creates HEAD http request method
+ * @param path - url path to method eg. /foo/bar/:id
+ */
+export declare function Head(path?: string, schema?: any): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+/**
+ * Creates PATCH http request method
+ * @param path - url path to method eg. /foo/bar/:id
+ */
+export declare function Patch(path?: string, schema?: any): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+/**
+ * Creates DELETE http request method
+ * @param path - url path to method eg. /foo/bar/:id
+ * @param routeName - route name visible in api. If undefined, method name is taken
+ */
+export declare function Del(path?: string, schema?: any): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+/**
+ * Creates PUT http request method
+ * @param path - url path to method eg. /foo/bar/:id
+ */
+export declare function Put(path?: string, schema?: any): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+/**
+ * Creates GET http request method
+ * @param path - url path to method eg. /foo/bar/:id
+ */
+export declare function Get(path?: string, schema?: any): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
+/**
+ * Creates POST http request method
+ *
+ * @param path - url path to method eg. /foo/bar
+ */
+export declare function Post(path?: string, schema?: any): (target: any, propertyKey?: string | symbol, indexOrDescriptor?: number | PropertyDescriptor) => void;
 //# sourceMappingURL=decorators.d.ts.map