Interface RouteHandleDescription

Available keys for use within a routes handle.

0.13.0

interface RouteHandleDescription {
    backend_url?: string;
    metadata?: apiRootMetadata;
    url_post?: string;
    url_redirect?: string;
}

Properties

backend_url?: string

URL base for the backend.

Cached apiRootMetadata from the backend at RouteHandleDescription.backend_url. This key must not be populated by the end-user when declaring routes. The key is automatically populated by dynamicRouter

url_post?: string

This key is only used by Redirect layout.

URL to perform a HTTP/POST against.

url_redirect?: string

This key is only used by Redirect layout.

URL to redirect to.