Trakteer.js
    Preparing search index...

    Interface AgentOptions

    Make all properties in T optional

    interface AgentOptions {
        keepAlive?: boolean;
        keepAliveMsecs?: number;
        maxSockets?: number;
        maxTotalSockets?: number;
        maxFreeSockets?: number;
        timeout?: number;
        scheduling?: "fifo" | "lifo";
        onread?: OnReadOpts;
        port?: number;
        host?: string;
        localAddress?: string;
        localPort?: number;
        hints?: number;
        family?: number;
        lookup?: LookupFunction;
        noDelay?: boolean;
        keepAliveInitialDelay?: number;
        autoSelectFamily?: boolean;
        autoSelectFamilyAttemptTimeout?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    keepAlive? keepAliveMsecs? maxSockets? maxTotalSockets? maxFreeSockets? timeout? scheduling? onread? port? host? localAddress? localPort? hints? family? lookup? noDelay? keepAliveInitialDelay? autoSelectFamily? autoSelectFamilyAttemptTimeout?

    Properties

    keepAlive?: boolean

    Keep sockets around in a pool to be used by other requests in the future. Default = false

    keepAliveMsecs?: number

    When using HTTP KeepAlive, how often to send TCP KeepAlive packets over sockets being kept alive. Default = 1000. Only relevant if keepAlive is set to true.

    maxSockets?: number

    Maximum number of sockets to allow per host. Default for Node 0.10 is 5, default for Node 0.12 is Infinity

    maxTotalSockets?: number

    Maximum number of sockets allowed for all hosts in total. Each request will use a new socket until the maximum is reached. Default: Infinity.

    maxFreeSockets?: number

    Maximum number of sockets to leave open in a free state. Only relevant if keepAlive is set to true. Default = 256.

    timeout?: number

    Socket timeout in milliseconds. This will set the timeout after the socket is connected.

    scheduling?: "fifo" | "lifo"

    Scheduling strategy to apply when picking the next free socket to use.

    lifo

    onread?: OnReadOpts

    If specified, incoming data is stored in a single buffer and passed to the supplied callback when data arrives on the socket. Note: this will cause the streaming functionality to not provide any data, however events like 'error', 'end', and 'close' will still be emitted as normal and methods like pause() and resume() will also behave as expected.

    port?: number
    host?: string
    localAddress?: string
    localPort?: number
    hints?: number
    family?: number
    lookup?: LookupFunction
    noDelay?: boolean
    keepAliveInitialDelay?: number
    autoSelectFamily?: boolean

    v18.13.0

    autoSelectFamilyAttemptTimeout?: number

    v18.13.0

    Settings

    Member Visibility

    On This Page

    Properties