@foal/core/lib/core/routes/utils.d.ts

Full-featured Node.js framework, with no complexity

import 'reflect-metadata';
import { Class } from '../class.interface';
/**
 * Get metadata of a class or a class method.
 *
 * @export
 * @param {string} metadataKey - The name of the metadata.
 * @param {Class} target - The class.
 * @param {string} [propertyKey] - The class method name if relevant.
 * @returns The metadata value.
 */
export declare function getMetadata(metadataKey: string, target: Class, propertyKey?: string): any;
/**
 * Get the HTTP method of a controller method.
 *
 * @export
 * @param {Class} target - The controller class.
 * @param {string} [propertyKey] - The method name.
 * @returns {(string|undefined)} - The HTTP method or undefined if none was defined.
 */
export declare function getHttpMethod(target: Class, propertyKey?: string): string | undefined;
/**
 * Get the path of a controller method.
 *
 * @export
 * @param {Class} target - The controller class.
 * @param {string} [propertyKey] - The method name.
 * @returns {(string|undefined)} - The path or undefined if none was defined.
 */
export declare function getPath(target: Class, propertyKey?: string): string | undefined;
/**
 * Join several HTTP request paths together.
 *
 * @export
 * @param {(...(string|undefined)[])} paths - The paths.
 * @returns {string} The resulted path.
 */
export declare function join(...paths: (string | undefined)[]): string;