Documentation
    Preparing search index...

    Type Alias UrlFor<Routes, Options>

    UrlFor: <Identifier extends keyof Routes["ALL"] & string>(
        ...[identifier, params, options]: RouteBuilderArguments<
            Identifier,
            Routes["ALL"][Identifier],
            Options,
        >,
    ) => string & {
        get<RouteIdentifier extends string>(
            ...__namedParameters: RouteBuilderArguments<
                RouteIdentifier,
                Routes["GET"][RouteIdentifier],
                Options,
            >,
        ): { method: "get"; url: string };
        post<RouteIdentifier extends string>(
            ...__namedParameters: RouteBuilderArguments<
                RouteIdentifier,
                Routes["POST"][RouteIdentifier],
                Options,
            >,
        ): { method: "post"; url: string };
        put<RouteIdentifier extends string>(
            ...__namedParameters: RouteBuilderArguments<
                RouteIdentifier,
                Routes["PUT"][RouteIdentifier],
                Options,
            >,
        ): { method: "put"; url: string };
        patch<RouteIdentifier extends string>(
            ...__namedParameters: RouteBuilderArguments<
                RouteIdentifier,
                Routes["PATCH"][RouteIdentifier],
                Options,
            >,
        ): { method: "patch"; url: string };
        delete<RouteIdentifier extends string>(
            ...__namedParameters: RouteBuilderArguments<
                RouteIdentifier,
                Routes["DELETE"][RouteIdentifier],
                Options,
            >,
        ): { method: "delete"; url: string };
        method<Method extends string, RouteIdentifier extends string>(
            method: Method,
            ...__namedParameters: RouteBuilderArguments<
                RouteIdentifier,
                Routes[Method][RouteIdentifier],
                Options,
            >,
        ): { method: Method; url: string };
    }

    The urlFor helper is used to make URLs for pre-existing known routes. You can make a URL using the route name, route pattern, or the route controller reference (depends upon enabled lookupStrategies)

    urlFor('users.show', [1]) // /users/1

    // Lookup inside a specific domain
    urlFor('blog.adonisjs.com@posts.show', [1]) // /posts/1

    Type Parameters

    Type Declaration

      • <Identifier extends keyof Routes["ALL"] & string>(
            ...[identifier, params, options]: RouteBuilderArguments<
                Identifier,
                Routes["ALL"][Identifier],
                Options,
            >,
        ): string
      • Type Parameters

        • Identifier extends keyof Routes["ALL"] & string

        Parameters

        Returns string

    • get: function
      • Make URL for a GET route. An error will be raised if the route doesn't exist.

        urlFor.get('users.show', [1]) // { method: 'get', url: '/users/1' }
        urlFor.get('users.store', [1]) // Error: Route not found GET@users/store

        Type Parameters

        • RouteIdentifier extends string

        Parameters

        Returns { method: "get"; url: string }

    • post: function
      • Make URL for a POST route. An error will be raised if the route doesn't exist.

        urlFor.post('users.store') // { method: 'post', url: '/users' }
        urlFor.post('users.show', [1]) // Error: Route not found POST@users.show

        Type Parameters

        • RouteIdentifier extends string

        Parameters

        Returns { method: "post"; url: string }

    • put: function
      • Make URL for a PUT route. An error will be raised if the route doesn't exist.

        urlFor.put('users.update', [1]) // { method: 'put', url: '/users/1' }
        urlFor.put('users.show', [1]) // Error: Route not found PUT@users.show

        Type Parameters

        • RouteIdentifier extends string

        Parameters

        Returns { method: "put"; url: string }

    • patch: function
      • Make URL for a PATCH route. An error will be raised if the route doesn't exist.

        urlFor.put('users.update', [1]) // { method: 'patch', url: '/users/1' }
        urlFor.put('users.show', [1]) // Error: Route not found PATCH@users.show

        Type Parameters

        • RouteIdentifier extends string

        Parameters

        Returns { method: "patch"; url: string }

    • delete: function
      • Make URL for a DELETE route. An error will be raised if the route doesn't exist.

        urlFor.delete('users.destroy', [1]) // { method: 'delete', url: '/users/1' }
        urlFor.delete('users.show', [1]) // Error: Route not found DELETE@users.show

        Type Parameters

        • RouteIdentifier extends string

        Parameters

        Returns { method: "delete"; url: string }

    • method: function
      • Make URL for a custom route method. An error will be raised if the route doesn't exist for the same method.

        Type Parameters

        • Method extends string
        • RouteIdentifier extends string

        Parameters

        Returns { method: Method; url: string }