/** ------------------------------------------------------- * * ***A list of routes and their parameters and bindings.*** * ------------------------------------------------------- * * Extended and filled by the route list generated with `php artisan rzl-ziggy:generate --types`. */ interface RouteList{} /** ------------------------------------------------------- * * ***Marker interface to configure Rzl Ziggy's type checking behavior.*** * ------------------------------------------------------- */ interface TypeConfig{} /** ------------------------------------------------------- * * ***A route name registered with Ziggy.*** * ------------------------------------------------------- */ type KnownRouteName=keyof RouteList; /** ------------------------------------------------------- * * ***A route name, or any string.*** * ------------------------------------------------------- */ type RouteName=KnownRouteName |(string &{}); /** ------------------------------------------------------- * * ***A valid route name to pass to `route()` to generate a URL.*** * ------------------------------------------------------- */ type ValidRouteName=TypeConfig extends{strictRouteNames:true;}? KnownRouteName:RouteName; /** ------------------------------------------------------- * * ***Information about a single route parameter.*** * ------------------------------------------------------- */ type ParameterInfo={name:string;required:boolean;binding?:string;}; /** ------------------------------------------------------- * * ***A primitive route parameter value, as it would appear in a URL.*** * ------------------------------------------------------- */ type RawParameterValue=string | number; /** ------------------------------------------------------- * * ***An object parameter value containing the 'default' binding key `id`, e.g. representing an Eloquent model.*** * ------------------------------------------------------- */ type DefaultRoutable={id:RawParameterValue;}& Record; /** ------------------------------------------------------- * * ***A route parameter value 1.*** * ------------------------------------------------------- */ type ParameterValue=RawParameterValue | DefaultRoutable; /** ------------------------------------------------------- * * ***A route parameter value 2.*** * ------------------------------------------------------- */ type ParameterValueProps=DefaultRoutable; /** ------------------------------------------------------- * * ***A parse-able route parameter, either plain or nested inside an object under its binding key.*** * ------------------------------------------------------- */ type Routable=I extends{binding:string;}?({[K in I["binding"]]:RawParameterValue;}& Record)| RawParameterValue:ParameterValue;type RequiredParams=Extract;type OptionalParams=Extract; /** ------------------------------------------------------- * * ***An object containing a special '_query' key to target the query string of a URL.*** * ------------------------------------------------------- */ type HasQueryParam={_query?:Record;}; /** ------------------------------------------------------- * * ***An object of parameters for an unspecified route.*** * ------------------------------------------------------- */ type GenericRouteParamsObject=Record& HasQueryParam; /** ------------------------------------------------------- * * ***An object of parameters for a specific named route.*** * ------------------------------------------------------- */ type KnownRouteParamsObject={[T in RequiredParamsas T["name"]]:Routable;}&{[T in OptionalParamsas T["name"]]?:Routable;}& GenericRouteParamsObject; /** ------------------------------------------------------- * * ***An object of route parameters.*** * ------------------------------------------------------- */ type RouteParamsObject=N extends KnownRouteName ? KnownRouteParamsObject:GenericRouteParamsObject; /** ------------------------------------------------------- * * ***An array of parameters for an unspecified route.*** * ------------------------------------------------------- */ type GenericRouteParamsArray=unknown[]; /** ------------------------------------------------------- * * ***An array of parameters for a specific named route.*** * ------------------------------------------------------- */ type KnownRouteParamsArray=[ ...{[K in keyof I]:Routable;},...unknown[]]; /** ------------------------------------------------------- * * ***An array of route parameters.*** * ------------------------------------------------------- */ type RouteParamsArray=N extends KnownRouteName ? KnownRouteParamsArray:GenericRouteParamsArray; /** ------------------------------------------------------- * * ***All possible parameter argument shapes for a route.*** * ------------------------------------------------------- */ type RouteParams=RouteParamsObject| RouteParamsArray; /** ------------------------------------------------------- * * ***A Route Definition Type.*** * ------------------------------------------------------- */ type RouteDefinition={uri:string;methods:("GET" | "HEAD" | "POST" | "PATCH" | "PUT" | "OPTIONS" | "DELETE")[];domain?:string;parameters?:string[];bindings?:Record;wheres?:Record;middleware?:string[];}; /** ------------------------------------------------------- * * ***Rzl Ziggy's config props for `route()`.*** * ------------------------------------------------------- */ type Config={url:string;port:number | null;defaults:Record;routes:Record;location?:{host?:string;pathname?:string;search?:string;};}; /** ------------------------------------------------------- */ type ParsedQs={[key:string]:undefined | string | ParsedQs |(string | ParsedQs)[];}; /** ------------------------------------------------------- * * ***Rzl Ziggy's Router Instance Class.*** * ------------------------------------------------------- * * Calling Rzl Ziggy's `route()` function with no arguments will return an instance of its JavaScript `Router` class, which has some other useful properties and methods. */ type Router={ /** --------------------------------------------- * * ***Check the current route: `route().current()`*** * --------------------------------------------- * * @example * // Laravel route called 'events.index' with URI '/events' * // Current window URL is https://ziggy.test/events * * route().current(); // ➔ 'events.index' * * @example * * // Laravel route called 'venues.events.show' with URI '/venues/{venue}/events/{event}' * // Current window URL is https://myapp.com/venues/1/events/2?hosts=all * * route().current(); // ➔ 'venues.events.show' * * @see [Check **@rzl-zone/ziggy-route** the current route: ***`route().current()`***.](https://github.com/rzl-zone/ziggy-route#check-the-current-route-routecurrent) * */ current():ValidRouteName | undefined; /** --------------------------------------------- * * ***Check the current route with name route: `route().current(...)`*** * --------------------------------------------- * * @example * // Laravel route called 'events.index' with URI '/events' * // Current window URL is https://ziggy.test/events * * route().current('events.index'); // ➔ true * route().current('events.*'); // ➔ true * route().current('events.show'); // ➔ false * * @example * * // `route().current()` optionally accepts parameters as its second argument, and will check that their values also match in the current URL: * * // Laravel route called 'venues.events.show' with URI '/venues/{venue}/events/{event}' * // Current window URL is https://myapp.com/venues/1/events/2?hosts=all * * route().current('venues.events.show', { venue: 1 }); // ➔ true * route().current('venues.events.show', { venue: 1, event: 2 }); // ➔ true * route().current('venues.events.show', { hosts: 'all' }); // ➔ true * route().current('venues.events.show', { venue: 6 }); // ➔ false * * @see [Check **@rzl-zone/ziggy-route** the current route: ***`route().current(...)`***.](https://github.com/rzl-zone/ziggy-route#check-the-current-route-routecurrent) * */ current(name:T,params?:RouteParams| ParameterValueProps | null):boolean; /** --------------------------------------------- * * ***Retrieve the current route with all params (query search params and laravel route params): `route().params`*** * --------------------------------------------- * @example * * // Laravel route called 'venues.events.show' with URI '/venues/{venue}/events/{event}' * // Current window URL is https://myapp.com/venues/1/events/2?hosts=all&type=test * * route().params; // ➔ { venue: '1', event: '2', hosts: 'all', type: 'test' } * * @see [Retrieve the current route with all params (query search params and laravel route params): ***`route().params`***.](https://github.com/rzl-zone/ziggy-route?tab=readme-ov-file#retrieve-the-current-route-params-routeparams) * */ get params():Record; /** --------------------------------------------- * * ***Retrieve only params route in laravel route (except query search params) in the current route: `route().routeParams`*** * --------------------------------------------- * @example * * // Laravel route called 'venues.events.show' with URI '/venues/{venue}/events/{event}' * // Current window URL is https://myapp.com/venues/1/events/2?hosts=all&type=test * * route().routeParams; // ➔ { venue: '1', event: '2' } * * @see [Retrieve only params route in laravel route (except query search params) in the current route: ***`route().routeParams`***.](https://github.com/rzl-zone/ziggy-route?tab=readme-ov-file#retrieve-only-params-route-in-laravel-route-except-query-search-params-in-the-current-route-routerouteparams) */ get routeParams():Record; /** --------------------------------------------- * * ***Retrieve all search query params only (except params route in laravel route) in the current route: `route().queryParams`*** * --------------------------------------------- * @example * * // Laravel route called 'venues.events.show' with URI '/venues/{venue}/events/{event}' * // Current window URL is https://myapp.com/venues/1/events/2?hosts=all&type=test * * route().queryParams; // ➔ { hosts: 'all', type: 'test' } * * @see [Retrieve all search query params only (except params route in laravel route) in the current route: ***`route().queryParams`***.](https://github.com/rzl-zone/ziggy-route?tab=readme-ov-file#retrieve-all-search-query-params-only-except-params-route-in-laravel-route-in-the-current-route-routequeryparams) */ get queryParams():ParsedQs; /** --------------------------------------------- * * ***Check the current route: `route().has(...)`*** * --------------------------------------------- * @example * * // Laravel app has only one named route, 'home' * * route().has('home'); // ➔ true * route().has('orders'); // ➔ false * * @see [Check **@rzl-zone/ziggy-route** if a route exists: ***`route().has(...)`***.](https://github.com/rzl-zone/ziggy-route#check-if-a-route-exists-routehas) * */ has(name:T):boolean;}; /** ------------------------------------------------------- * * ***Types For RouteFactory Class.*** * ------------------------------------------------------- */ type RouteFactoryConfig={url:string;port:number | null;absolute?:boolean;defaults:Record;routes:Record;location?:{host?:string;pathname?:string;search?:string;};}; /** ------------------------------------------------------- * * ***Types For RouterConfig Class.*** * ------------------------------------------------------- */ type RouterConfig={url:string;port:number | null;absolute?:boolean;defaults:Record;routes:Record;location?:{host?:string;pathname?:string;search?:string;};};export type{Config as C,KnownRouteName as K,ParameterValueProps as P,Router as R,TypeConfig as T,ValidRouteName as V,RouteParams as a,RouterConfig as b,ParameterValue as c,ParsedQs as d,RawParameterValue as e,RouteDefinition as f,RouteFactoryConfig as g,RouteList as h,RouteName as i};