UNPKG

@adonisjs-community/girouette

Version:

An AdonisJS package allowing decorators-based routing.

43 lines (42 loc) 1.07 kB
/** * The Group decorator allows you to configure route groups with names and prefixes. * * @param options Configuration object for the group * * @example * ```ts * // Using name and prefix * @Group({ name: 'admin', prefix: '/admin' }) * export default class AdminController {} * * // Using just a name * @Group({ name: 'admin' }) * export default class AdminController {} * * // Using just a prefix * @Group({ prefix: '/admin' }) * export default class AdminController {} * ``` */ export declare const Group: (options: { name?: string; prefix?: string; }) => (target: any) => void; /** * The GroupDomain decorator allows you to restrict all routes within a controller * to a specific domain. * * @param domain Domain to restrict routes to * * @example * ```ts * @GroupDomain('admin.example.com') * export default class AdminController { * @Get('/admin/dashboard') * index() { * // Only accessible via admin.example.com * } * } * ``` */ export declare const GroupDomain: (domain: string) => (target: any) => void;