Type Alias AniLinkOptions

Transport settings accepted by an AniLink client: timeout, signal, automatic retries under the default policy (retry: false opts out), paceWithRateLimit pacing (on by default), opt-in circuitBreaker fast-fail, lifecycle hooks, and exposeRawAxiosError.

Every operation method also accepts an optional trailing options argument of this type. It is merged over the instance-level settings for that one call: a field set on the per-request object wins, and unset fields keep the instance value. The nested retry, circuitBreaker, and retryBudget objects merge field-by-field, so a per-request { retry: { maxRetries: 0 } } keeps the instance's other retry knobs:

const aniLink = new AniLink("token", { timeout: 5_000 });

// Uses the instance timeout of 5 seconds.
await aniLink.anilist.query.media({ id: 1, type: "ANIME" });

// Raises the timeout for this call only; everything else stays instance-scoped.
await aniLink.anilist.query.mediaListCollection(
    { userId: 542244, type: "ANIME" },
    { timeout: 30_000 }
);
Copy