Class RouteResource<ActionNames>

constructor

• new RouteResource<ActionNames extends ResourceActionNames = ResourceActionNames>(
      app: Application<any>,
      routerMiddleware: ParsedGlobalMiddleware[],
      options: {
          resource: string;
          controller: string | Constructor<any> | LazyImport<Constructor<any>>;
          globalMatchers: RouteMatchers;
          shallow: boolean;
      },
  ): RouteResource<ActionNames>

  Creates a new RouteResource instance

  Type Parameters

  • ActionNames extends ResourceActionNames = ResourceActionNames

  Parameters

  • app: Application<any>

    The AdonisJS application instance

  • routerMiddleware: ParsedGlobalMiddleware[]

    Array of global middleware registered on the router

  • options: {
        resource: string;
        controller: string | Constructor<any> | LazyImport<Constructor<any>>;
        globalMatchers: RouteMatchers;
        shallow: boolean;
    }

    Configuration options for the route resource

  Returns RouteResource<ActionNames>

routes

only

• only<Name extends ResourceActionNames>(names: Name[]): RouteResource<Name>

  Register only given routes and remove others

  Type Parameters

  • Name extends ResourceActionNames

  Parameters

  • names: Name[]

    Array of action names to keep

  Returns RouteResource<Name>

  Current RouteResource instance with filtered actions

except

• except<Name extends ResourceActionNames>(
      names: Name[],
  ): RouteResource<Exclude<ActionNames, Name>>

  Register all routes, except the one's defined

  Type Parameters

  • Name extends ResourceActionNames

  Parameters

  • names: Name[]

    Array of action names to exclude

  Returns RouteResource<Exclude<ActionNames, Name>>

  Current RouteResource instance with filtered actions

apiOnly

• apiOnly(): RouteResource<Exclude<ActionNames, "create" | "edit">>

  Register api only routes. The create and edit routes, which are meant to show forms will not be registered

  Returns RouteResource<Exclude<ActionNames, "create" | "edit">>

  Current RouteResource instance without create and edit actions

where

• where(key: string, matcher: string | RegExp | RouteMatcher): this

  Define matcher for params inside the resource

  Parameters

  • key: string

    The parameter name to match

  • matcher: string | RegExp | RouteMatcher

    The matcher pattern (RegExp, string, or RouteMatcher)

  Returns this

  Current RouteResource instance for method chaining

tap

• tap(callback: (route: Route) => void): this

  Tap into multiple routes to configure them by their name

  Parameters

  • callback: (route: Route) => void

    Function to configure routes

  Returns this

  Current RouteResource instance for method chaining

• tap(
      actions: ActionNames | ActionNames[],
      callback: (route: Route) => void,
  ): this

  Tap into multiple routes to configure them by their name

  Parameters

  • actions: ActionNames | ActionNames[]

    Action name(s) to configure

  • callback: (route: Route) => void

    Function to configure matching routes

  Returns this

  Current RouteResource instance for method chaining

params

• params(resources: { [resource: string]: string }): this

  Set the param name for a given resource

  Parameters

  • resources: { [resource: string]: string }

    Object mapping resource names to parameter names

  Returns this

  Current RouteResource instance for method chaining

use

• use(
      actions: "*" | ActionNames | ActionNames[],
      middleware: OneOrMore<ParsedNamedMiddleware | MiddlewareFn>,
  ): this

  Define one or more middleware on the routes created by the resource.

  Calling this method multiple times will append middleware to existing list.

  Parameters

  • actions: "*" | ActionNames | ActionNames[]

    Action name(s) or '*' for all actions

  • middleware: OneOrMore<ParsedNamedMiddleware | MiddlewareFn>

    Middleware function(s) to apply

  Returns this

  Current RouteResource instance for method chaining

middleware

• middleware(
      actions: "*" | ActionNames | ActionNames[],
      middleware: OneOrMore<ParsedNamedMiddleware | MiddlewareFn>,
  ): this

  Alias for RouteResource.use

  Parameters

  • actions: "*" | ActionNames | ActionNames[]

    Action name(s) or '*' for all actions

  • middleware: OneOrMore<ParsedNamedMiddleware | MiddlewareFn>

    Middleware function(s) to apply

  Returns this

  Current RouteResource instance for method chaining

as

• as(name: string, normalizeName?: boolean): this

  Prepend name to all the routes

  Parameters

  • name: string

    The name to prepend to all route names

  • normalizeName: boolean = true

    Whether to normalize the name to snake_case

  Returns this

  Current RouteResource instance for method chaining