AniLink - v3.1.0
    Preparing search index...

    Interface RestExecuteOptions

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

    Every field except path is optional. Each operation sets only the options it needs. execute applies them in a fixed order so requests follow the same rules across the API.

    interface RestExecuteOptions {
        body?: string | object;
        contentType?: string;
        method?: HttpMethod;
        pathParams?: Readonly<Record<string, string | number>>;
        query?: Record<string, unknown>;
        requiresAuth?: boolean;
        retrySafety?: RetrySafety;
        transportOptions?: RequestOptions;
    }
    Index
    body? contentType? method? pathParams? query? requiresAuth? retrySafety? transportOptions?

    Optional Readonlybody

    body?: string | object

    The request body (POST/PUT/PATCH): a JSON object, or a pre-encoded string body (for example a form-urlencoded list-status payload), when provided.

    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".

    pathParams?: Readonly<Record<string, string | number>>

    Values substituted into {placeholder} segments of path. Defaults to an empty map so paths without placeholders need none.

    query?: Record<string, unknown>

    Query parameters appended to the URL (GET/DELETE), when provided.

    requiresAuth?: boolean

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

    retrySafety?: RetrySafety

    Whether replay can safely repeat this operation's effects. This is independent of the HTTP method and defaults to safe for compatibility. Mark non-idempotent operations unsafe.

    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