js-routes 2.3.7 → 2.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/lib/routes.d.ts CHANGED
@@ -1,78 +1 @@
1
- type Optional<T> = {
2
- [P in keyof T]?: T[P] | null;
3
- };
4
- type Collection<T> = Record<string, T>;
5
- type BaseRouteParameter = string | boolean | Date | number | bigint;
6
- type MethodRouteParameter = BaseRouteParameter | (() => BaseRouteParameter);
7
- type ModelRouteParameter = {
8
- id: MethodRouteParameter;
9
- } | {
10
- to_param: MethodRouteParameter;
11
- } | {
12
- toParam: MethodRouteParameter;
13
- };
14
- type RequiredRouteParameter = BaseRouteParameter | ModelRouteParameter;
15
- type OptionalRouteParameter = undefined | null | RequiredRouteParameter;
16
- type QueryRouteParameter = OptionalRouteParameter | QueryRouteParameter[] | {
17
- [k: string]: QueryRouteParameter;
18
- };
19
- type RouteParameters = Collection<QueryRouteParameter>;
20
- type Serializable = Collection<unknown>;
21
- type Serializer = (value: Serializable) => string;
22
- type RouteHelperExtras = {
23
- requiredParams(): string[];
24
- toString(): string;
25
- };
26
- type RequiredParameters<T extends number> = T extends 1 ? [RequiredRouteParameter] : T extends 2 ? [RequiredRouteParameter, RequiredRouteParameter] : T extends 3 ? [RequiredRouteParameter, RequiredRouteParameter, RequiredRouteParameter] : T extends 4 ? [
27
- RequiredRouteParameter,
28
- RequiredRouteParameter,
29
- RequiredRouteParameter,
30
- RequiredRouteParameter
31
- ] : RequiredRouteParameter[];
32
- type RouteHelperOptions = RouteOptions & Collection<OptionalRouteParameter>;
33
- type RouteHelper<T extends number = number> = ((...args: [...RequiredParameters<T>, RouteHelperOptions]) => string) & RouteHelperExtras;
34
- type RouteHelpers = Collection<RouteHelper>;
35
- type Configuration = {
36
- prefix: string;
37
- default_url_options: RouteParameters;
38
- special_options_key: string;
39
- serializer: Serializer;
40
- };
41
- interface RouterExposedMethods {
42
- config(): Configuration;
43
- configure(arg: Partial<Configuration>): Configuration;
44
- serialize: Serializer;
45
- }
46
- type KeywordUrlOptions = Optional<{
47
- host: string;
48
- protocol: string;
49
- subdomain: string;
50
- port: string | number;
51
- anchor: string;
52
- trailing_slash: boolean;
53
- script_name: string;
54
- params: RouteParameters;
55
- }>;
56
- type RouteOptions = KeywordUrlOptions & RouteParameters;
57
- type PartsTable = Collection<{
58
- r?: boolean;
59
- d?: OptionalRouteParameter;
60
- }>;
61
- type ModuleType = "CJS" | "AMD" | "UMD" | "ESM" | "DTS" | "NIL";
62
- declare const RubyVariables: {
63
- PREFIX: string;
64
- DEPRECATED_FALSE_PARAMETER_BEHAVIOR: boolean;
65
- DEPRECATED_NIL_QUERY_PARAMETER_BEHAVIOR: boolean;
66
- SPECIAL_OPTIONS_KEY: string;
67
- DEFAULT_URL_OPTIONS: RouteParameters;
68
- SERIALIZER: Serializer;
69
- ROUTES_OBJECT: RouteHelpers;
70
- MODULE_TYPE: ModuleType;
71
- WRAPPER: <T>(callback: T) => T;
72
- };
73
- declare const define: undefined | (((arg: unknown[], callback: () => unknown) => void) & {
74
- amd?: unknown;
75
- });
76
- declare const module: {
77
- exports: unknown;
78
- } | undefined;
1
+ export {};