gremlin
    Preparing search index...

    Type Alias ConnectionOptions

    type ConnectionOptions = {
        auth?: RequestInterceptor;
        batchSize?: number;
        bulkResults?: boolean;
        compression?: Compression;
        enableUserAgentOnConnect?: boolean;
        interceptors?: RequestInterceptor | RequestInterceptor[];
        keepAliveTimeMillis?: number;
        logger?: Logger;
        maxConnections?: number;
        maxResponseHeaderBytes?: number;
        pdtRegistry?: any;
        preciseNumbers?: boolean;
        proxy?: string;
        readTimeoutMillis?: number;
        responseSerializer?: any;
        traversalSource?: string;
    }
    Index

    Properties

    auth? batchSize? bulkResults? compression? enableUserAgentOnConnect? interceptors? keepAliveTimeMillis? logger? maxConnections? maxResponseHeaderBytes? pdtRegistry? preciseNumbers? proxy? readTimeoutMillis? responseSerializer? traversalSource?

    Properties

    auth?: RequestInterceptor

    An optional auth interceptor. As a convenience, this is always appended to the end of the interceptor list so it runs last, after any user interceptors have modified the request.

    batchSize?: number

    Connection-level default that fills a request's batchSize when it is left unset. Defaults to 64.

    bulkResults?: boolean

    Connection-level default for bulkResults, applied to every request unless overridden per-request. Defaults to false.

    compression?: Compression

    Response compression codec. Defaults to 'deflate' (on).

    enableUserAgentOnConnect?: boolean
    interceptors?: RequestInterceptor | RequestInterceptor[]
    keepAliveTimeMillis?: number

    Idle time in milliseconds before TCP keep-alive probes begin on a connection. Defaults to 30000 (30s) when unset. Set to 0 to disable keep-alive entirely.

    logger?: Logger

    An optional logger (a logger object or a callback). Logging is disabled when unset.

    maxConnections?: number

    Maximum number of concurrent connections per origin. Defaults to 128.

    maxResponseHeaderBytes?: number

    Maximum size of the response headers in bytes, applied to the default dispatcher.

    pdtRegistry?: any
    preciseNumbers?: boolean
    proxy?: string

    HTTP proxy URI. When set, requests are routed through an undici ProxyAgent.

    readTimeoutMillis?: number

    Idle-read (body) timeout in milliseconds, applied to the default dispatcher.

    responseSerializer?: any
    traversalSource?: string

    Settings

    Member Visibility

    On This Page

    Properties