AniLink - v2.0.0
    Preparing search index...

    Interface RestExecuteOptions

    The declarative contract a REST operation passes to RestOperation.execute.

    Every field except the path is optional: an operation declares only the variation points it needs, and execute applies them in a fixed order so request behaviour is uniform across the whole API surface.

    interface RestExecuteOptions {
        contentType?: string;
        method?: HttpMethod;
        requiresAuth?: boolean;
        transportOptions?: RequestOptions;
    }
    Index
    contentType? method? requiresAuth? transportOptions?
    contentType?: string

    The Content-Type of the request. Defaults to "application/json", which also opts every REST call out of GraphQL envelope unwrapping in the shared transport pipeline.

    method?: HttpMethod

    The HTTP method for the call. Defaults to "GET".

    requiresAuth?: boolean

    Whether the operation requires an authentication token. Defaults to false (public endpoints).

    transportOptions?: RequestOptions

    Per-request transport settings (timeout, signal, retry policy, lifecycle hooks, pacing, circuit breaker) merged over the instance-level options for this single call. A field set here wins; unset fields keep the instance value.

    Settings
    Member Visibility

    On This Page
    Properties