@u4/adbkit
    Preparing search index...

    Interface ClientOptions

    interface ClientOptions {
        allowHalfOpen?: boolean;
        autoSelectFamily?: boolean;
        autoSelectFamilyAttemptTimeout?: number;
        backend?: "auto" | "native" | "ya-webadb";
        bin?: string;
        blockList?: BlockList;
        family?: number;
        fd?: number;
        handle?: BoundSocket;
        hints?: number;
        host?: string;
        keepAlive?: boolean;
        keepAliveInitialDelay?: number;
        localAddress?: string;
        localPort?: number;
        lookup?: LookupFunction;
        noDelay?: boolean;
        onread?: OnReadOpts;
        port: number;
        readable?: boolean;
        signal?: AbortSignal;
        stopNativeAdbServerOnUsbBusy?: boolean;
        timeout?: number;
        typeOfService?: number;
        writable?: boolean;
    }

    Hierarchy

    • TcpNetConnectOpts
      • ClientOptions
    Index
    allowHalfOpen?: boolean
    autoSelectFamily?: boolean

    v18.13.0

    autoSelectFamilyAttemptTimeout?: number

    v18.13.0

    backend?: "auto" | "native" | "ya-webadb"

    Select the transport. auto uses ya-webadb for local hosts when available. ya-webadb requires the optional dependencies and fails if they are unavailable.

    bin?: string

    As the sole exception, this option provides the path to the adb binary, used for starting the server locally if initial connection fails. Defaults to 'adb'.

    blockList?: BlockList
    family?: number
    fd?: number
    handle?: BoundSocket
    hints?: number
    host?: string
    keepAlive?: boolean
    keepAliveInitialDelay?: number
    localAddress?: string
    localPort?: number
    lookup?: LookupFunction
    noDelay?: boolean
    onread?: OnReadOpts
    port: number
    readable?: boolean
    signal?: AbortSignal
    stopNativeAdbServerOnUsbBusy?: boolean

    Allow ya-webadb to stop the local native ADB server when USB is busy. Defaults to false.

    timeout?: number
    typeOfService?: number
    writable?: boolean