routes
CompiledRoute
A route that has been compiled to include uri variables.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
route |
Route
|
The route itself. |
required |
uri |
str
|
The endpoint for this route. |
required |
Source code in unkey/routes.py
params
class-attribute
instance-attribute
The query params for the route.
with_params
Adds additional query params to this compiled route.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
params |
t.Dict[str, t.Any]
|
The query params to compile. |
required |
Returns:
Type | Description |
---|---|
CompiledRoute
|
The compiled route for chained calls. |
Source code in unkey/routes.py
Route
A route that has not been compiled yet.
Source code in unkey/routes.py
compile
Turn this route into a compiled route.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
*args |
t.Union[str, int]
|
The arguments to insert into the uri. |
()
|
Returns:
Type | Description |
---|---|
CompiledRoute
|
The compiled route. |