@izzyjs/route
Version:
Use your AdonisJs routes in your Inertia.js application
49 lines (48 loc) • 1.35 kB
TypeScript
/**
* @izzyjs/route
*
* (c) IzzyJs - 2024
* For the full license information, please view the LICENSE file that was distributed with this source code.
*/
import { ExcludeName, ExtractName, Params } from '../types/routes.js';
import { Route, Routes } from '../route.js';
/**
* Resolve a route path by its name and parameters
* @param routeName The name of the route
* @param params The parameters of the route
* @returns The resolved route path
* @example
* ```ts
* route('users.show', { id: '1' })
* // => "/users/1"
* ```
*/
export declare function route<Name extends ExtractName>(routeName: Name, options: {
params: Params<Name>;
qs?: Record<string, any>;
prefix?: string;
hash?: string;
}): Route;
/**
* Resolve a route path by its name
* @param routeName The name of the route
* @returns The resolved route path
* @example
* ```ts
* route('users.index')
* // => "/users"
* ```
*/
export declare function route<Name extends ExcludeName>(routeName: Name, options?: {
params?: never;
qs?: Record<string, any>;
prefix?: string;
hash?: string;
}): Route;
export declare function route(): Routes;
export declare namespace route {
export var current: typeof Routes.current;
var _a: typeof Route.new;
export var builder: typeof import("../builder.js").default;
export { _a as new };
}