@nktkas/hyperliquid/esm/api/subscription/_methods/_base/_config.d.ts

Hyperliquid API SDK for all major JS runtimes, written in TypeScript.

/**
 * Configuration and option types for Subscription API methods.
 * @module
 */
/// <amd-module name="file:///home/runner/work/hyperliquid/hyperliquid/src/api/subscription/_methods/_base/_config.ts" />
import type { ISubscriptionTransport, TransportError } from "../../../../transport/mod.js";
/** Configuration for subscription API requests. */
export interface SubscriptionConfig<T extends ISubscriptionTransport = ISubscriptionTransport> {
    /** The transport used to connect to the Hyperliquid API. */
    transport: T;
}
/** Options for Subscription API methods. */
export interface SubscriptionOptions {
    /** Stops waiting for the confirmation and detaches the listener. */
    signal?: AbortSignal;
    /**
     * Callback invoked at most once, when an already confirmed subscription fails:
     * - the server rejects a re-subscription after a reconnect;
     * - the connection is permanently terminated;
     * - the connection goes down while re-subscription is disabled.
     *
     * Failures before the confirmation reject the subscribe promise instead.
     * After the callback fires, the subscription is removed and no further events or errors follow.
     */
    onError?: (error: TransportError) => void;
}