@adonisjs-community/girouette/build/src/decorators/resource.d.ts

An AdonisJS package allowing decorators-based routing.

type ResourceOptions = {
    name: string;
    params?: {
        [resource: string]: string;
    };
} | string;
/**
 * The Resource decorator automatically defines RESTful routes for a controller.
 *
 * @param options - The options for the resource routes.
 * @param options.name - The name of the resource, used for route naming and as resource identifier.
 * @param options.params - The parameters to rename in the resource routes.
 *
 * @example
 * ```ts
 * // Simple resource with custom params
 * @Resource({ name: 'posts', params: { posts: 'post' } })
 * export default class PostsController {
 *   // Generates routes:
 *   // GET    /posts               (posts.index)
 *   // GET    /posts/create        (posts.create)
 *   // POST   /posts               (posts.store)
 *   // GET    /posts/:post       (posts.show)
 *   // GET    /posts/:post/edit  (posts.edit)
 *   // PUT    /posts/:post       (posts.update)
 *   // DELETE /posts/:post       (posts.destroy)
 * }
 * ```
 * @example
 * ```ts
 * // Nested resource
 * @Resource({name: 'posts.comments', params: { posts: 'post', comments: 'comment' }})
 * export default class PostsCommentsController {
 *   // Generates routes:
 *   // GET    /posts/:post/comments                (posts.comments.index)
 *   // GET    /posts/:post/comments/create         (posts.comments.create)
 *   // POST   /posts/:post/comments                (posts.comments.store)
 *   // GET    /posts/:post/comments/:comment       (posts.comments.show)
 *   // GET    /posts/:post/comments/:comment/edit  (posts.comments.edit)
 *   // PUT    /posts/:post/comments/:comment       (posts.comments.update)
 *   // DELETE /posts/:post/comments/:comment       (posts.comments.destroy)
 * }
 * ```
 * @example
 * ```ts
 * // String shorthand for simple resources
 * @Resource('/posts')
 * export default class PostsController {
 *   // Generates routes:
 *   // GET    /posts               (posts.index)
 *   // GET    /posts/create        (posts.create)
 *   // POST   /posts               (posts.store)
 *   // GET    /posts/:id           (posts.show)
 *   // GET    /posts/:id/edit      (posts.edit)
 *   // PUT    /posts/:id           (posts.update)
 *   // DELETE /posts/:id           (posts.destroy)
 * }
 * ```
 */
export declare const Resource: (options: ResourceOptions) => (target: any) => void;
export {};