@shieldz/sdk
    Preparing search index...

    Interface ShieldzOptions

    interface ShieldzOptions {
        apiKey: string;
        baseUrl?: string;
        fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise<Response>;
        maxRetries?: number;
        maxRetryDelayMs?: number;
        timeoutMs?: number;
    }
    Index

    Properties

    apiKey baseUrl? fetch? maxRetries? maxRetryDelayMs? timeoutMs?

    Properties

    apiKey: string

    Your secret API key (sk_live_… or sk_test_…).

    baseUrl?: string

    Override the API base URL. Default: https://shieldz.cash/api/v1

    fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise<Response>

    Custom fetch. Defaults to global fetch (Node 18+).

    Type Declaration

      • (input: URL | RequestInfo, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: URL | RequestInfo
        • Optionalinit: RequestInit

        Returns Promise<Response>

    maxRetries?: number

    Retries for transient failures (network, timeout, 429, 5xx). Default 2; 0 disables.

    maxRetryDelayMs?: number

    Cap on a single backoff delay, in ms. Default 8000.

    timeoutMs?: number

    Per-request timeout in ms. Default 30000.

    Settings

    Member Visibility

    On This Page

    Properties