AniLink - v3.0.0
    Preparing search index...

    Interface DispatchOptions

    Named trailing options for BaseOperation.dispatch, replacing the former positional tail so call sites name their arguments and new options can be added without reordering. Mirrors the SendRequestOptions pattern already used by sendRequest.

    BaseOperation

    interface DispatchOptions {
        contentType?: string;
        operation?: string;
        protocol?: "graphql" | "rest";
        requiresAuth?: boolean;
        transportOptions?: RequestOptions;
    }
    Index
    contentType? operation? protocol? requiresAuth? transportOptions?
    contentType?: string

    Optional Content-Type header override for non-GraphQL endpoints. This is purely a header concern; response interpretation is controlled by protocol. When protocol is omitted, a set contentType implies the "rest" protocol.

    operation?: string

    Human-readable operation name included in missing-token auth errors. Defaults to the concrete subclass name.

    protocol?: "graphql" | "rest"

    The wire protocol of the request, selecting response interpretation and error classification. "graphql" unwraps the envelope; "rest" returns the body verbatim. When omitted, the protocol is inferred from contentType.

    requiresAuth?: boolean

    Whether the operation requires an authentication token; the request fails fast with an AniLinkAuthError when set and no auth material is configured. Defaults to false.

    transportOptions?: RequestOptions

    Per-request RequestOptions merged over the instance-level ones. A field set here wins; unset fields keep the instance value.

    Settings
    Member Visibility

    On This Page
    Properties