Document default baseURL behavior when omitted
Co-authored-by: Eric Allam <eric@trigger.dev>
This commit is contained in:
@@ -653,7 +653,8 @@ the failure is surfaced through `onError` with phase `reconnect`.
|
||||
Subsequent reconnect calls will retry stale inactive-state cleanup until it succeeds.
|
||||
If `onError` is omitted, reconnect still returns `null` and continues without callback reporting.
|
||||
|
||||
`baseURL` supports optional path prefixes and trailing slashes; both trigger and stream URLs
|
||||
`baseURL` defaults to `https://api.trigger.dev` when omitted.
|
||||
It supports optional path prefixes and trailing slashes; both trigger and stream URLs
|
||||
are normalized consistently, surrounding whitespace is trimmed before normalization, and
|
||||
the resulting value must not be empty. The value must also be a valid absolute URL using
|
||||
the `http` or `https` protocol, without query parameters, hash fragments, or embedded
|
||||
|
||||
@@ -29,3 +29,4 @@
|
||||
- Documented that `HTTP://` and `HTTPS://` are accepted (case-insensitive protocol matching).
|
||||
- Added deterministic validation ordering for multi-issue baseURL values
|
||||
(protocol → query/hash → credentials).
|
||||
- Documented explicit default `baseURL` value (`https://api.trigger.dev`) when omitted.
|
||||
|
||||
@@ -157,6 +157,7 @@ both cleanup steps (`set` inactive state and `delete`) even if one of them fails
|
||||
|
||||
## Base URL behavior
|
||||
|
||||
- `baseURL` defaults to `https://api.trigger.dev` when omitted.
|
||||
- `baseURL` supports optional path prefixes (for example reverse-proxy mounts).
|
||||
- Trailing slashes are normalized automatically before trigger/stream requests.
|
||||
- Surrounding whitespace is trimmed before normalization.
|
||||
|
||||
Reference in New Issue
Block a user